mbrucedogs/ai-docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: clarify reader doc placement

Browse Source
This commit is contained in:
Matt Bruce 2026-02-10 15:35:37 -06:00
parent efb59096e7
commit 8833c282a3
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Agents.md
View File

@ -40,6 +40,16 @@ When using AI to add or change docs in this repo:
4. Update the index when adding new markdown files. 4. Update the index when adding new markdown files.
5. Verify formatting (bullets, code blocks, and links) before commit. 5. Verify formatting (bullets, code blocks, and links) before commit.
## When A New Chat Starts
If you had to restart a chat and re-explain the goal, add a short reminder so the assistant places content in the reader-facing docs instead of workflow files.
### What To Say (Plain English)
- "Treat this repo like a book for developers. Put reader-facing guidance in docs/ai, not in Agents.md."
- "If placement is unclear, ask where the content should live before editing."
### Example Request
"Read Agents.md and PRD.md first. Propose a plan. Then add chat mode guidance to docs/ai/usage-tokens.md (reader-facing) with hard examples. Do not add reader content to Agents.md."
## Commit And Push After Repo Updates ## Commit And Push After Repo Updates
If you update any file in this repo, commit and push right away so other developers do not lose their local changes. If you are unsure, ask and confirm before pushing. If you update any file in this repo, commit and push right away so other developers do not lose their local changes. If you are unsure, ask and confirm before pushing.