|
| 1 | +--- |
| 2 | +name: update-docs |
| 3 | +description: Synchronize README, docs, and AGENT guidance with the actual codebase and tooling. Use when implementation changed commands, behavior, configuration, architecture, or project structure. |
| 4 | +--- |
| 5 | + |
| 6 | +# update-docs |
| 7 | + |
| 8 | +Update repository documentation to match the current implementation. |
| 9 | + |
| 10 | +## Phase 1: Inspect the Current Source of Truth |
| 11 | + |
| 12 | +Read the smallest set of files that define behavior: |
| 13 | + |
| 14 | +1. entry points and changed source files |
| 15 | +2. build and dependency manifests |
| 16 | +3. CI workflows |
| 17 | +4. `README.md`, `docs/`, `AGENT.md` |
| 18 | +5. `docs/development-memo.md` when present |
| 19 | + |
| 20 | +Do not update docs from memory. Derive every command and path from the repository. |
| 21 | + |
| 22 | +## Phase 2: Update the Right Document |
| 23 | + |
| 24 | +Use this split: |
| 25 | + |
| 26 | +- `README.md`: how to install, run, configure, and use the project |
| 27 | +- `docs/`: design rationale, ADRs, requirements, internal notes |
| 28 | +- `AGENT.md`: repo-specific instructions for Codex |
| 29 | + |
| 30 | +For GitReal specifically, keep `README.md` and `docs/development-memo.md` aligned on: |
| 31 | + |
| 32 | +1. executable name `git-real` |
| 33 | +2. user-facing command `git real` |
| 34 | +3. safety model around `arm`, backups, and rescue |
| 35 | +4. planned Go-based architecture |
| 36 | + |
| 37 | +Common updates: |
| 38 | + |
| 39 | +1. build, test, lint, format, or release commands |
| 40 | +2. config file names and option descriptions |
| 41 | +3. module layout and entry points |
| 42 | +4. examples and sample outputs |
| 43 | +5. workflow or validation requirements |
| 44 | + |
| 45 | +## Phase 3: Consistency Check |
| 46 | + |
| 47 | +Verify consistency across docs: |
| 48 | + |
| 49 | +1. file paths |
| 50 | +2. command names |
| 51 | +3. option flags |
| 52 | +4. module names |
| 53 | +5. stated prerequisites |
| 54 | + |
| 55 | +If the repo has no established command for something, say that plainly instead of inventing one. |
| 56 | + |
| 57 | +## Phase 4: Report the Update |
| 58 | + |
| 59 | +Summarize in this form: |
| 60 | + |
| 61 | +```markdown |
| 62 | +## Documentation Update |
| 63 | + |
| 64 | +Updated: |
| 65 | +- <file>: <what changed> |
| 66 | + |
| 67 | +Open gaps: |
| 68 | +- ... |
| 69 | + |
| 70 | +Remaining assumptions: |
| 71 | +- ... |
| 72 | +``` |
| 73 | + |
| 74 | +## Editing Rules |
| 75 | + |
| 76 | +- keep README user-facing and concise |
| 77 | +- keep developer guidance close to the code it explains |
| 78 | +- prefer exact commands over prose-only instructions |
| 79 | +- remove stale claims instead of softening them |
0 commit comments