dtoro
b5c1247093
Problem: after the wiki-hq reorg, agent-instruction and human-doc domains were still scattered across the repo root, with three now-redundant stub files cluttering it. The organizing principle wasn't visible in the layout. Change — enforce three clear buckets: - .agents/ = how agents operate: OIKOS.md, HERMES.md (moved from root), shared/ conventions, domains/ schemas, skills/, and operations/ (operator cheatsheet + enrollment + hermes-agent, moved from root). - knowledge/ = what exists + evidence: wiki/, GLOSSARY.md, and sources/ now including investigations/ (incident records are evidence/sources). - root = substrate + two entry points (AGENTS.md, README.md), plus plans/ as its own design-intent domain. Moves: - investigations/ -> knowledge/sources/investigations/ (incl. archive/, index). - operations/ -> .agents/operations/. - HERMES.md -> .agents/HERMES.md. - Deleted unreferenced root stubs CAVEMAN.md, CONTRIBUTING.md, and OIKOS.md (its 7 remaining linkers repointed to .agents/OIKOS.md). Consumers updated: - inventory.yaml doc_page (agent-enrollment) + regenerated hosts/*.yaml + cards. - tools/setup-hermes-soul.sh and bootstrap.sh (x2) -> .agents/HERMES.md. - bin/homelab help string -> .agents/operations/hermes-agent.md. - knowledge/operations schemas, llm-wiki, page-templates, incident-investigation skill, AGENTS.md/README nav -> new investigations/operations paths. - All markdown links rewritten via the path-resolving mapper. Left in place (substrate/executable/separate-domain): hosts/, ledger/, tools/, plans/, oikos/, mcp/, secrets/, bin/, inventory.yaml. Verification: docs-lint at baseline (2 intentional cross-repo refs, no new breakage); gen-topology.py --check exit 0; build_host_files.py idempotent; all doc_page targets resolve; Hermes provisioning scripts point at the new path. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
56 lines
2.5 KiB
Markdown
56 lines
2.5 KiB
Markdown
# Operations domain — schema
|
|
|
|
The operations domain holds the procedural and time-stamped documentation: runbooks (repeatable
|
|
procedures), investigations (incident evidence), and plans (design docs for non-trivial work). It
|
|
follows [writing-style](../../shared/writing-style.md); runbooks and plans use the imperative voice
|
|
exception.
|
|
|
|
Where each kind lives: runbooks are skills under [`.agents/skills/`](../../skills/); operator
|
|
reference (command cheatsheet, enrollment, Hermes agent) lives in
|
|
[`.agents/operations/`](../../operations/); investigations are sources under
|
|
`knowledge/sources/investigations/`; plans stay in the repo-root `plans/` folder (below).
|
|
|
|
## Plans always live in `plans/`
|
|
|
|
**Any plan or design doc for the Homelab is written into the repo `plans/` folder as
|
|
`plans/YYYY-MM-DD-slug.md` — never a scratch path, an agent-private plan location, or a chat
|
|
message.** An agent drafting a plan:
|
|
|
|
1. Writes the file under `plans/` using the plan template in [page-templates.md](../../shared/page-templates.md).
|
|
2. Lists it in `plans/index.md`.
|
|
3. On completion, moves it to `plans/done/` and updates the index status.
|
|
|
|
This is the single source for homelab design intent; keeping it in-repo means the plan is
|
|
versioned, reviewable, and reachable by MCP `get_page`/`search_docs` like any other doc.
|
|
|
|
## Runbooks
|
|
|
|
Repeatable procedures are skills — one folder per skill at `.agents/skills/<name>/SKILL.md`, with
|
|
YAML front-matter that the Oikos policy and lifecycle machinery reads:
|
|
|
|
```yaml
|
|
---
|
|
name: <name>
|
|
risk_class: read_only | reversible_low | config_mutation | destructive
|
|
inputs: [<param>, ...]
|
|
verification: "<shell expression that proves success>"
|
|
docs_update_checklist: [<doc artifacts to update>]
|
|
transition: "<from> -> <to>" # only for lifecycle runbooks
|
|
---
|
|
```
|
|
|
|
`risk_class` values and the lifecycle `transition` states must match
|
|
[`oikos/policy.yaml`](../../../oikos/policy.yaml) and [`oikos/ontology.yaml`](../../../oikos/ontology.yaml).
|
|
|
|
## Investigations
|
|
|
|
Incident records live in `knowledge/sources/investigations/YYYY-MM-DD-slug.md` and are **evidence sources** — written
|
|
once at incident time, then linked from the changelogs of the nodes they implicate. Sections:
|
|
`## Summary`, `## Timeline`, `## Root cause`, `## Mitigations applied`, `## Open questions`. Resolved
|
|
incidents move to `knowledge/sources/investigations/archive/`.
|
|
|
|
## The operations log
|
|
|
|
`plans/log.md` and `knowledge/log.md` are append-only records of documentation operations on
|
|
those areas (`## [YYYY-MM-DD] <op> | <summary>`), distinct from the Oikos change ledger.
|