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

docs: add doc navigation rules

Browse Source
This commit is contained in:
Matt Bruce 2026-02-11 10:58:40 -06:00
parent 96a3497862
commit 5b514f80ff
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Agents.md
View File

@ -44,6 +44,15 @@ When using AI to add or change docs in this repo:
4. Update the index when adding new markdown files.
5. Verify formatting (bullets, code blocks, and links) before commit.
## Doc Navigation Pattern (Required)
If you add, remove, or rename any file under docs/ai:
1. Update [docs/ai/index.md](docs/ai/index.md) with the new or removed entry.
2. Add or update the page breadcrumb ("You are here") on the page.
3. Add or update the page "Contents" block.
4. Add or update the "Next Steps" block so readers can navigate forward.
5. Verify all links still resolve.
## 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.