Skip to content

docs: add docs/ tree to AGENTS.md structure map#45

Merged
devantler merged 1 commit into
mainfrom
claude/docs-agents-md-structure-docs-tree
Jun 27, 2026
Merged

docs: add docs/ tree to AGENTS.md structure map#45
devantler merged 1 commit into
mainfrom
claude/docs-agents-md-structure-docs-tree

Conversation

@devantler

Copy link
Copy Markdown
Contributor

🤖 Generated by the Daily AI Assistant

What

Add the docs/ directory to the ## Structure tree in AGENTS.md — it was the only top-level path missing from the map.

Why

The ## Structure block 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 entire docs/ tree, which on main holds 18 operator-facing documentation filesBOOTSTRAP, TEMPLATING, TENANTS, node-autoscaling, oidc-kubectl, runtime-security, rwx-storage, secret-rotation, plus the 7-file disaster-recovery set under docs/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 on AGENTS.md as the canonical map would have missed the DR runbooks entirely.

Change

Two added entries (docs/ + docs/dr/) to the structure code-block, annotated TEMPLATE-OWNED, mirroring the existing tree style and listing the live filenames. Docs-only; no behaviour, manifest, or CI impact.

Validation

  • Entries verified against the live tree (gh api .../git/trees/main?recursive=1) — every listed file exists.
  • Markdown-only edit inside the existing fenced block; no build/manifest/lint path affected.

Trivial agent-file freshness fix (no behaviour change) → no separate issue filed, per the contract's trivial-fix carve-out.

@devantler devantler marked this pull request as ready for review June 27, 2026 08:10
@devantler devantler requested a review from a team as a code owner June 27, 2026 08:10
@devantler devantler merged commit 17f352e into main Jun 27, 2026
11 checks passed
@devantler devantler deleted the claude/docs-agents-md-structure-docs-tree branch June 27, 2026 08:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant