docs: correct file naming convention — foundational docs are ALL-CAPS
The previous naming guide was incomplete. The actual convention is: **Foundational docs:** ALL-CAPS - Root entry-points: AGENTS.md, README.md (discovery paths) - Agent instruction: .agents/OIKOS.md, .agents/HERMES.md (docs agents read first) - Reference docs: GLOSSARY.md (like classic repo files: LICENSE, CHANGELOG) **Content pages:** lowercase-with-dashes - Containers: <id>-<name>.md (ID from inventory) - Infrastructure: <topic>.md (system description) - Plans/investigations: YYYY-MM-DD-slug.md (date-sorted) - Section indices: README.md (conventional) **Skills:** special pattern - <name>/SKILL.md where <name> is lowercase-with-dashes - SKILL.md filename is always uppercase — signpost for tools and humans Uppercase is reserved for foundational/signpost docs; all paths otherwise use lowercase with hyphens (no underscores). Updated page-templates.md with expanded explanation, and updated AGENTS.md + README.md to reference the corrected convention. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
@@ -78,9 +78,9 @@ Grep is fine for browsing or when MCP is unreachable.
|
||||
See [page-templates.md](.agents/shared/page-templates.md) for file naming, page
|
||||
structure, and the tone standard. Quick reference:
|
||||
|
||||
- **File naming:** Root entry-points are ALL-CAPS (`AGENTS.md`); containers use
|
||||
`<id>-<name>.md`; infrastructure uses lowercase-with-dashes; plans and investigations
|
||||
use `YYYY-MM-DD-slug.md`; skills are folders with `SKILL.md` inside.
|
||||
- **File naming:** Foundational docs are ALL-CAPS (AGENTS.md, OIKOS.md, GLOSSARY.md);
|
||||
containers use `<id>-<name>.md`; infrastructure uses lowercase-with-dashes; plans
|
||||
and investigations use `YYYY-MM-DD-slug.md`; skills are `<name>/SKILL.md`.
|
||||
- **Where pages live:** Narrative under `knowledge/wiki/{containers,hosts,vms,infrastructure}/`;
|
||||
incident records under `knowledge/sources/investigations/`; runbook procedures under
|
||||
`.agents/skills/<name>/SKILL.md`; operator reference under `.agents/operations/`;
|
||||
|
||||
Reference in New Issue
Block a user