docs: codebase review + documentation maintenance pass

Full review (plans/2026-07-17-codebase-review-and-cleanup.md) covering Go,
web SPA, and docs. Applied low-risk doc/tooling fixes; code refactors and
dead-code deletions are listed as actionable recommendations pending approval.

Doc fixes:
- AGENTS.md: remove ghost of retired request_execution (contradicted the
  retire notice above it); fix knowledge/wiki/ -> archive/knowledge/;
  replace brittle counts (33 tools, 36 docs, 20 checks) with pointers to
  source; drop point-in-time dates.
- OIKOS.md: fix broken plan link (now in done/); 001-011 -> 001-020;
  15 MCP tools -> pointer; replace hardcoded knowledge counts.
- README.md: 15 tools -> pointer; fix wails plan link (now in done/);
  complete internal/ package list (add checkdefaults, observability, safego);
  add cmd/desktop/ to repo layout.
- commands.md, page-templates.md: fix broken links; HERMES.md -> NOMOS.md.

Plans housekeeping:
- Move 4 done 2026-07-14 plans from plans/ to plans/done/.
- Reconcile plans/index.md: add the 2 missing 2026-07-14 entries and the
  2 missing 2026-07-15 done entries; add this review.
- Fix stale plan path in migrations/020 comment.

New docs:
- docs/index.md and docs/operations/README.md (folder READMEs per
  writing-style.md).

Tooling:
- web/package.json: add check/typecheck/lint scripts + svelte-check devDep.
- Makefile: desktop-package version now reads from VERSION file instead of
  hardcoded 0.1.0.

VERSION 0.7.6 -> 0.7.7 (patch: docs + tooling only).
This commit is contained in:
2026-07-17 22:04:54 +02:00
parent 55781984c7
commit e3a0326c78
17 changed files with 525 additions and 43 deletions

16
docs/index.md Normal file
View File

@@ -0,0 +1,16 @@
# Docs
Long-form reference material for the Oikos platform. Operational state and
topology live in the DB (seeded from `seeds/`); these docs cover decisions,
procedures, and the system model.
| Path | Contents |
| ---- | -------- |
| [adr/](adr/README.md) | Architecture Decision Records (numbered, append-only) |
| [mbse/](mbse/README.md) | Model-Based Systems Engineering views of the platform |
| [operations/](operations/README.md) | Operator runbooks (deploy, rollback, recovery) |
For agent orientation see [AGENTS.md](../AGENTS.md); for the operating model
see [.agents/OIKOS.md](../.agents/OIKOS.md); for development see
[CONTRIBUTING.md](../CONTRIBUTING.md). Design plans live in
[plans/](../plans/), not here.

18
docs/operations/README.md Normal file
View File

@@ -0,0 +1,18 @@
# Operations runbooks
Step-by-step procedures for operating the homelab. These complement the
agent-facing skill files in [`.agents/skills/`](../../.agents/skills/) (which
are machine-actionable) and the deploy scripts in
[`scripts/`](../../scripts/) (which are executable).
| Runbook | Scope |
| ------- | ----- |
| [rollback.md](rollback.md) | Rollback a deploy: checkout SHA + pg_restore |
For the deploy pipeline itself see
[`scripts/deploy.sh`](../../scripts/deploy.sh), the watchdog at
[`scripts/watchdog.sh`](../../scripts/watchdog.sh), and the cutover checklist
at [`scripts/cutover-checklist.md`](../../scripts/cutover-checklist.md). The
risk classification for any mutation is defined in
[`seeds/policy.yaml`](../../seeds/policy.yaml) — run `oikos` MCP `preflight`
to check the class before acting.