Documentation
Technical guide
Everything below is readable on this site — no need to leave for GitHub to learn the product. The landing page stays the product story; this hub is the deep map.
Learn the basics
Overview
What it is, who it is for, how much ceremony.
Quick start
First ten minutes — install, init, first change.
How it works
Demand → Assurance → Learning story.
Concepts
Change, Contract, Evidence, Assurance, Skill, and more.
Glossary
Short definitions.
FAQ
Common questions.
From Spec Guardrails
Migration map from the predecessor.
Landscape
How Retornatus compares to adjacent harnesses.
Workflows
Tutorials
Guided walks — first change, brownfield wake.
Skills
On-demand specialization Skills.
Memory
Learnings, index, wake continuity.
Governance
Authority, Rules, Policy, Human Decisions.
Git governance
Commit / PR / merge / publish blast-radius tiers.
Cloud agents
Clean VMs: install the CLI, reinstall hooks, leave receipts unsigned.
Agent hooks
Opt-in Stop hook for Claude, Cursor, and Codex. CI stays the source of truth.
Reference
Gates
Mechanical STOP gates and Assurance verdicts.
JSON output
Versioned verdict envelope for verify, gates, and overview.
GitHub Action
Sticky pull-request comment with the verdict, claims, and gates.
CLI
Intention-oriented commands.
Presets
init --preset for Python, platform ship and AI surfaces, FastAPI, Django, RAG, and background workers.
Architecture
Layers, persistence, native-first adapters.
Environments
Cursor, Claude Code, Codex, generic hosts.
Non-goals
What Retornatus deliberately is not.
Credits & lineage
Predecessor influences and original design notes.
Markdown sources (for editors):
docs/guide on GitHub.
Rebuild HTML after edits: python scripts/build_docs_html.py.