docs(agents): trim AGENTS.md and relocate detail to docs/ - #21
Merged
Merged
Conversation
- Move the full 'Gotchas discovered the hard way' list to
docs/specs/gotchas.md; AGENTS.md keeps a one-line-per-group summary.
- Move the phase status table and end-to-end verification notes to
docs/HANDOFF.md ('Project status'); AGENTS.md keeps a pointer.
- Update the Documentation Policy and repository layout for docs/specs/.
- Point the TECHNICAL-DESIGN risk table at docs/specs/gotchas.md instead
of AGENTS.md.
AGENTS.md: 242 -> 149 lines. No information removed, only relocated.
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.
Summary
Reduces
AGENTS.mdfrom 242 to 149 lines while staying an operational context file (project snapshot, rules, layout, commands, testing conventions, pointers). No information was deleted — only relocated.Where each moved section now lives
AGENTS.mdGotchas discovered the hard way(full list, 34 entries in 7 groups)docs/specs/gotchas.md(new focused spec);AGENTS.mdkeeps a one-line-per-group summary with a pointerStatus and handoff(phase 0–10 table + end-to-end verification notes)docs/HANDOFF.md→ new## Project statussection;AGENTS.mdkeeps a pointer with the next taskAlso updated (so nothing dangles)
AGENTS.mdDocumentation Policy and repository layout now includedocs/specs/*.md(this also makes the existingdocs/adr/README.mdlink to../specs/resolve).docs/TECHNICAL-DESIGN.mdrisk-table mitigation now points todocs/specs/gotchas.mdinstead ofAGENTS.md.AGENTS.md,docs/*.md,docs/specs/anddocs/adr/: all links resolve (thedocs/images/*.pnglinks inREADME.mdwere already broken onmainand are untouched here).Verification
wc -l AGENTS.md= 149 (≤ 200)diffagainstorigin/main)