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:
@@ -6,14 +6,25 @@ in [writing-style.md](writing-style.md); the layer model (sources / wiki / index
|
|||||||
|
|
||||||
## File naming
|
## File naming
|
||||||
|
|
||||||
- **Root entry-point files:** ALL-CAPS (e.g. `AGENTS.md`, `README.md`). These are discovery paths — agents and humans find them first.
|
**Foundational / entry-point files:** ALL-CAPS
|
||||||
- **Container pages:** `<id>-<name>.md` (e.g. `101-jellyfin.md`, `132-rclone.md`). The `<id>` is the LXC/VM ordinal from `inventory.yaml`.
|
|
||||||
- **Infrastructure / cross-cutting pages:** lowercase-with-dashes (e.g. `dns.md`, `auto-deploy.md`, `mesh.md`). Describes a system, not a specific node.
|
|
||||||
- **Plans / investigations / time-stamped docs:** `YYYY-MM-DD-<slug>.md` (e.g. `2026-07-05-oikos-prometheus-lxc.md`). Date first, then lowercase slug.
|
|
||||||
- **Skills / runbooks:** folder name is lowercase-with-dashes (e.g. `client-enrollment/`), contains `SKILL.md` (uppercase). Emphasizes the skill-name for navigation.
|
|
||||||
- **Indices:** `README.md` or `index.md` (both lowercase). Prefer `README.md` for folders; use `index.md` only when both an intro page and a listing coexist.
|
|
||||||
|
|
||||||
All paths use lowercase letters, numbers, and hyphens (no underscores). This keeps them readable, shell-friendly, and consistent across the repo.
|
- **Root level:** `AGENTS.md`, `README.md` — discovery paths for agents and humans.
|
||||||
|
- **Agent instruction** (under `.agents/`): `OIKOS.md`, `HERMES.md` — foundational docs agents read before acting.
|
||||||
|
- **Reference docs:** `GLOSSARY.md` — lookup reference (like classic repo conventions: LICENSE, CHANGELOG, GLOSSARY).
|
||||||
|
|
||||||
|
**Content / narrative pages:** lowercase-with-dashes, date-prefixed as needed
|
||||||
|
|
||||||
|
- **Container pages:** `<id>-<name>.md` (e.g. `101-jellyfin.md`, `132-rclone.md`). The `<id>` is the LXC/VM ordinal from `inventory.yaml`.
|
||||||
|
- **Infrastructure / cross-cutting pages:** `<topic>.md` (e.g. `dns.md`, `auto-deploy.md`, `mesh.md`). Describes a system, not a specific node.
|
||||||
|
- **Plans / investigations:** `YYYY-MM-DD-<slug>.md` (e.g. `2026-07-05-oikos-prometheus-lxc.md`). Date-sorted; slug is lowercase.
|
||||||
|
- **Section indices:** `README.md` (lowercase, conventional). Prefer in folders; `index.md` only if both intro prose and listing coexist.
|
||||||
|
|
||||||
|
**Skills / runbooks:** special case
|
||||||
|
|
||||||
|
- **Folder structure:** `<name>/SKILL.md` where `<name>` is lowercase-with-dashes (e.g. `client-enrollment/SKILL.md`).
|
||||||
|
- **The filename SKILL.md is always uppercase** — it acts as a signpost so tools and humans instantly recognize it as a skill.
|
||||||
|
|
||||||
|
**General rules:** All paths use lowercase letters, numbers, and hyphens (no underscores). Uppercase is reserved for foundational docs (entry points + instruction) and filenames that signify document type (SKILL.md, GLOSSARY.md, etc.).
|
||||||
|
|
||||||
## Voice
|
## Voice
|
||||||
|
|
||||||
|
|||||||
@@ -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
|
See [page-templates.md](.agents/shared/page-templates.md) for file naming, page
|
||||||
structure, and the tone standard. Quick reference:
|
structure, and the tone standard. Quick reference:
|
||||||
|
|
||||||
- **File naming:** Root entry-points are ALL-CAPS (`AGENTS.md`); containers use
|
- **File naming:** Foundational docs are ALL-CAPS (AGENTS.md, OIKOS.md, GLOSSARY.md);
|
||||||
`<id>-<name>.md`; infrastructure uses lowercase-with-dashes; plans and investigations
|
containers use `<id>-<name>.md`; infrastructure uses lowercase-with-dashes; plans
|
||||||
use `YYYY-MM-DD-slug.md`; skills are folders with `SKILL.md` inside.
|
and investigations use `YYYY-MM-DD-slug.md`; skills are `<name>/SKILL.md`.
|
||||||
- **Where pages live:** Narrative under `knowledge/wiki/{containers,hosts,vms,infrastructure}/`;
|
- **Where pages live:** Narrative under `knowledge/wiki/{containers,hosts,vms,infrastructure}/`;
|
||||||
incident records under `knowledge/sources/investigations/`; runbook procedures under
|
incident records under `knowledge/sources/investigations/`; runbook procedures under
|
||||||
`.agents/skills/<name>/SKILL.md`; operator reference under `.agents/operations/`;
|
`.agents/skills/<name>/SKILL.md`; operator reference under `.agents/operations/`;
|
||||||
|
|||||||
@@ -64,7 +64,7 @@ Resolved cases move to [`investigations/archive/`](knowledge/sources/investigati
|
|||||||
|
|
||||||
## Conventions
|
## Conventions
|
||||||
|
|
||||||
- **File naming.** Root entry-points are ALL-CAPS; containers use `<id>-<name>.md`; infrastructure pages use lowercase-with-dashes; plans and incident records use `YYYY-MM-DD-slug.md`. See [page-templates.md](.agents/shared/page-templates.md) for the full rules.
|
- **File naming.** Foundational docs (entry-points, agent instruction, references) are ALL-CAPS (`AGENTS.md`, `OIKOS.md`, `GLOSSARY.md`); containers use `<id>-<name>.md`; infrastructure pages use lowercase-with-dashes; plans and incidents use `YYYY-MM-DD-slug.md`; skills are `<name>/SKILL.md`. See [page-templates.md](.agents/shared/page-templates.md) for the full rules.
|
||||||
- **Each node page** ends with a `## Changelog` section. Reverse-chronological. Entry format:
|
- **Each node page** ends with a `## Changelog` section. Reverse-chronological. Entry format:
|
||||||
```
|
```
|
||||||
### YYYY-MM-DD — short title
|
### YYYY-MM-DD — short title
|
||||||
|
|||||||
Reference in New Issue
Block a user