docs: add docs/ tree to AGENTS.md structure map#45
Merged
Conversation
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
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
Add the
docs/directory to the## Structuretree inAGENTS.md— it was the only top-level path missing from the map.Why
The
## Structureblock enumerates every top-level directory and even single config files (down to.releaserc), and the file header promises agents should "Reference it first." Yet it omitted the entiredocs/tree, which onmainholds 18 operator-facing documentation files —BOOTSTRAP,TEMPLATING,TENANTS,node-autoscaling,oidc-kubectl,runtime-security,rwx-storage,secret-rotation, plus the 7-file disaster-recovery set underdocs/dr/(README,runbook,restore-drill,alerting,crypto-custody,openbao,velero-cnpg).docs/is not in.templatesyncignore, so it is template-owned shared plumbing synced to every instance — exactly the kind of path the structure map should name. An agent relying onAGENTS.mdas the canonical map would have missed the DR runbooks entirely.Change
Two added entries (
docs/+docs/dr/) to the structure code-block, annotatedTEMPLATE-OWNED, mirroring the existing tree style and listing the live filenames. Docs-only; no behaviour, manifest, or CI impact.Validation
gh api .../git/trees/main?recursive=1) — every listed file exists.Trivial agent-file freshness fix (no behaviour change) → no separate issue filed, per the contract's trivial-fix carve-out.