docs: add co-located backend AGENTS.md context files#371
Open
Blackgaurd wants to merge 1 commit into
Open
Conversation
move backend documentation out of the monolithic SPEC-backend.md into small AGENTS.md files co-located with the code they describe, so Claude Code loads each only when working in that subtree. corrects the layout drift to the real core/ package structure. nothing removed yet. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
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
1 participant
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.
What
Adds 9 co-located `AGENTS.md` files that carry the backend documentation next to the code they describe, corrected to the real `core/` package layout:
Nothing is removed in this PR, so the repo still builds and the old spec still resolves.
Why
`dev-docs/SPEC-backend.md` had grown to 728 lines and was eagerly `@import`ed into every session via root `AGENTS.md`, and had drifted stale (documented the pre-`core/` flat layout). Co-locating the docs lets Claude Code load each only when working in that subtree.
Benefit
Leaner per-session context, docs that live next to the code and are far less likely to drift.