Skip to content

docs: refresh against the code, diagrams in semantic colours, AGENTS.md - #57

Merged
grojof merged 2 commits into
mainfrom
docs/eunomai-refresh
Oct 8, 2026
Merged

grojof merged 2 commits into
mainfrom
docs/eunomai-refresh

Conversation

@grojof

@grojof grojof commented Oct 8, 2026

Copy link
Copy Markdown
Owner

Docs refresh with eunomai 0.6.1's living-docs flow: a read-only coherence audit of README + docs/ against the code (33 findings), then the fixes.

Docs

  • Diagrams in five shared semantic classes (step, ask, guard, stop, data), defined once in docs/architecture.md → Diagram conventions:
    • README main menu (now with every entry: Instance services, Remove instances, Fail2ban · Firewall);
    • layers (adds support.py, neutralise.py, i18n.py);
    • plan flow (the phrase is asked before the preview, as the code does; failure and Ctrl+C cleanup);
    • new: per-version install, neutralised copy, what each fail2ban jail blocks.
    • All six parse with mermaid 11 (with a negative control).
  • Drift fixed:
    • the fail2ban page told readers to run ufw enable with no SSH allow; it now points to the Firewall menu;
    • install-failure behaviour (returns to the menu; Ctrl+C);
    • the Odoo 12/13 host-Python rule, the PostgreSQL floor, the real PostgreSQL probe, CPU architectures (uv: x86_64/aarch64; wkhtmltopdf: amd64);
    • all validated values and derived paths;
    • proxy_mode in the posture checks;
    • dependency check by distribution name;
    • template copy refused for replicas, and a replica's role and core;
    • data dir defaults;
    • what Delete and Purge leave behind;
    • menu paths by submenu, and labels matching the UI.
  • One fact, one home: the glossary defines terms and links to their pages; the server report links to the posture list; the install page links to the support matrix.
  • Session-style and changelog-style prose made self-contained.
  • AGENTS.md is the instruction file (CLAUDE.md = @AGENTS.md bridge); CI pins eunomai v0.6.1 (docs-check follows links).

Code (found by the audit)

  • A failed install could drop a pre-existing PostgreSQL role: the cleanup ran DROP ROLE IF EXISTS for every PostgreSQL / Odoo + PostgreSQL install. It now drops the role only when this run created it.
  • Two Spanish literals left in management views are English keys.

Verification

pytest 196 passed; ruff, openspec validate --specs, eunomai 0.6.1 docs-check (22 links, 16 pages) and provenance-check clean.

Assisted-by: Claude

grojof added 2 commits October 8, 2026 13:45
…ated

The cleanup of a failed PostgreSQL or Odoo + PostgreSQL install dropped the
instance's role even when it existed before the run. The role's existence is
now read before the plan and the cleanup drops it only when the run created
it. Two Spanish literals left in the management views are English keys.
A coherence audit of README and docs against the code: pages follow the
menu's submenus; the install, neutralisation, validation and paths pages
state what the code does; the glossary defines and links instead of
repeating; the fail2ban page no longer suggests ufw enable without SSH.

Diagrams use five shared colour classes (step, ask, guard, stop, data),
defined once in docs/architecture.md: the main menu, the layers, the plan
flow, the per-version install, the neutralised copy and the ban scope.

AGENTS.md is the agent instruction file, CLAUDE.md a one-line bridge, and CI
checks the docs with eunomai v0.6.1.
@grojof
grojof merged commit 3ec440f into main Oct 8, 2026
1 check passed
@grojof
grojof deleted the docs/eunomai-refresh branch October 8, 2026 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant