docs: align runbooks and validation structure

This commit is contained in:
windyboy
2026-08-23 17:42:31 +08:00
parent fea9a6560f
commit 7bc7d3f99b
10 changed files with 68 additions and 32 deletions
+3 -4
View File
@@ -2,8 +2,6 @@
This repo is the **agent ops handbook + fact source** for maintaining personal VPS hosts. Prefer verifying live state over assuming docs are complete.
Also readable as `agent.md` (symlink → this file).
## How to work
1. Read [`inventory/hosts.md`](inventory/hosts.md) for the machine list.
@@ -125,7 +123,8 @@ Default triage labels: needs-triage, needs-info, ready-for-agent, ready-for-huma
### Domain docs
Single-context layout: `CONTEXT.md` + `docs/adr/` at the repo root. See `docs/agents/domain.md`.
Domain-documentation conventions, including lazily created `CONTEXT.md` and
`docs/adr/` entries when needed, are described in [`docs/agents/domain.md`](docs/agents/domain.md).
## Safety
@@ -158,7 +157,7 @@ Bills, rough notes, and personal clutter stay in the Obsidian vault. This repo h
## Layout
```
AGENTS.md / agent.md # this entry (agent.md → AGENTS.md)
AGENTS.md # this entry
RUNBOOKS.md # runbook spec (six-field model, naming, review rules)
inventory/hosts.md # machine index (human-readable source of truth)
ansible/ # playbooks, roles, sanitized control-plane inventory