split AGENTS.md into SDK-contributor + app-builder guides#1059
Open
FabienDanieau wants to merge 2 commits into
Open
split AGENTS.md into SDK-contributor + app-builder guides#1059FabienDanieau wants to merge 2 commits into
FabienDanieau wants to merge 2 commits into
Conversation
AGENTS.md was previously an app-development guide. Refocus it on SDK contribution (the audience working inside this repo), and move the app-development content to docs/contributing/building_apps.md. Add docs/contributing/architecture.md as a structural map for contributors: top-level layout, per-subpackage purpose, the daemon connection model showing FastAPI and webrtcsink as parallel transports that meet at the Backend, and a "where to look for X" lookup table. Move docs/contributing.md -> docs/contributing/contributing.md and docs/generate.md -> docs/contributing/generate_docs.md, both with clearer pre-commit/lint/test guidance, an AI-assisted-contribution section pointing at the Linux kernel coding-assistants convention, and explicit reminders to keep architecture.md/AGENTS.md in sync when the code architecture shifts. Repoint inbound references in README, skills, and docs/source/SDK/* to the new file paths. CLAUDE.md is left untouched. Assisted-by: Claude:claude-opus-4-7
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
| | `descriptions/` | URDFs and hardware metadata. | `descriptions/` | | ||
| | `tools/` | Utilities (motor firmware reflashing). | `tools/reflash_motors.py` | | ||
| | `utils/` | Helpers (interpolation math, mDNS discovery, rerun visualization, constants). | `utils/` | | ||
|
|
Member
There was a problem hiding this comment.
@RemiFabre Should we add something about moves/emotions here? Both to advertise the dataset approach and to make sure it's used by agents.
- AGENTS.md: broaden the js/reachy-mini.js description (any static page / tool / service, not just HF Spaces). - AGENTS.md: add a "Transport parity" working convention — REST / WS / WebRTC must expose the same feature set, all delegating to the same backend method. - AGENTS.md: add a PR-hygiene bullet about rebasing on main and confirming CI is green before requesting review. - docs/contributing/architecture.md: promote the parity rule from a trailing paragraph to a bolded callout right under the "Two transports" bullets, where it belongs. Defers @pierre-rouanet's moves/emotions suggestion on architecture.md pending @RemiFabre input. Assisted-by: Claude:claude-opus-4-7
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
AGENTS.md was previously an app-development guide. Refocus it on SDK contribution (the audience working inside this repo), and move the app-development content to docs/contributing/building_apps.md.
Add docs/contributing/architecture.md as a structural map for contributors: top-level layout, per-subpackage purpose, the daemon connection model showing FastAPI and webrtcsink as parallel transports that meet at the Backend, and a "where to look for X" lookup table.
Move docs/contributing.md -> docs/contributing/contributing.md and docs/generate.md -> docs/contributing/generate_docs.md, both with clearer pre-commit/lint/test guidance, an AI-assisted-contribution section pointing at the Linux kernel coding-assistants convention, and explicit reminders to keep architecture.md/AGENTS.md in sync when the code architecture shifts.
Repoint inbound references in README, skills, and docs/source/SDK/* to the new file paths. CLAUDE.md is left untouched.
Assisted-by: Claude:claude-opus-4-7