diff --git a/.agents/shared/page-templates.md b/.agents/shared/page-templates.md index d02efde..28d6440 100644 --- a/.agents/shared/page-templates.md +++ b/.agents/shared/page-templates.md @@ -6,14 +6,25 @@ in [writing-style.md](writing-style.md); the layer model (sources / wiki / index ## File naming -- **Root entry-point files:** ALL-CAPS (e.g. `AGENTS.md`, `README.md`). These are discovery paths — agents and humans find them first. -- **Container pages:** `-.md` (e.g. `101-jellyfin.md`, `132-rclone.md`). The `` 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-.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. +**Foundational / entry-point files:** ALL-CAPS -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:** `-.md` (e.g. `101-jellyfin.md`, `132-rclone.md`). The `` is the LXC/VM ordinal from `inventory.yaml`. +- **Infrastructure / cross-cutting pages:** `.md` (e.g. `dns.md`, `auto-deploy.md`, `mesh.md`). Describes a system, not a specific node. +- **Plans / investigations:** `YYYY-MM-DD-.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:** `/SKILL.md` where `` 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 diff --git a/AGENTS.md b/AGENTS.md index 07cae3a..6ad008b 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -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 - `-.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 `-.md`; infrastructure uses lowercase-with-dashes; plans + and investigations use `YYYY-MM-DD-slug.md`; skills are `/SKILL.md`. - **Where pages live:** Narrative under `knowledge/wiki/{containers,hosts,vms,infrastructure}/`; incident records under `knowledge/sources/investigations/`; runbook procedures under `.agents/skills//SKILL.md`; operator reference under `.agents/operations/`; diff --git a/README.md b/README.md index 53cc9b7..9bd425b 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ Resolved cases move to [`investigations/archive/`](knowledge/sources/investigati ## Conventions -- **File naming.** Root entry-points are ALL-CAPS; containers use `-.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 `-.md`; infrastructure pages use lowercase-with-dashes; plans and incidents use `YYYY-MM-DD-slug.md`; skills are `/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: ``` ### YYYY-MM-DD — short title