Conventions
Two layers
Section titled “Two layers”- Authored pages — hand-written, reviewed in a pull request. Explain why, not just what.
- Generated inventory — produced by
scripts/inventory.mjsfrom read-only SSH to each host. Never edited by hand; regenerate instead. Each page records the collection time and the commit.
If a generated page contradicts an authored page, the generated page is the measurement and the authored page is out of date — fix the authored page.
Page rules
Section titled “Page rules”- One fact per line, absolute paths, no secrets.
- Record the verification date on anything that can change (versions, IPs, container tags).
- Mark measured versus inferred explicitly.
- Link to the host page from every service page, and to the service pages from each host page.
Naming
Section titled “Naming”| Page | Path |
|---|---|
| Host | hosts/<hostname>.md |
| Network topic | network/<topic>.md |
| Stack boundary | stack/<topic>.md |
| Service | services/<service>.md |
| Generated | generated/<hostname>.md |
Adding a host or service
Section titled “Adding a host or service”- Add the host to
scripts/inventory.mjs(name, mesh IP, login user) — it is not discovered automatically. - Create the authored page under
hosts/orservices/. - Run
npm run inventory, review the diff, then commit both layers together.