Map of all docs

Every document in this repository, grouped by what it is for, with its status. If you are new, read Installation and Quick Start first; everything else here is for when you need it.

Documents outside the book live under docs/ in the repository and open on GitHub.

Start here

document	what it gives you
README	install, a first success, and wiring into an agent
Installation · Quick Start	the same path, in more depth
Configuration · Harness Integration	making it part of your workflow
Why Yupana · The Stack	what it is for, and how it fits with Quipu and Bobbin

Reference

Everything under Reference in the book's sidebar: the CLI, configuration, MCP tools, the resident daemon, the pre-edit policy guard, golden-path conformance, the enforcement trace, and share bundles.

outside the book	status
Agent action certification: the `yupana certify` record format	current

Specification and vision

document	status
Specification: the full build spec (requirements, architecture, phasing)	living; the reference for FR numbers
Vision: Bobbin × Yupana × Quipu	north star

Design

The book's Design section summarises the addenda below and links to them.

document	status
Golden-path conformance guard (FR-40..42)	built, first cut
Game-state and policy harness (FR-35..39)	built
Work-scoped agent governance	partially implemented; the doc says which parts
Governed landing policy	design, advise tier first
Paper plan: evidence-local constraint enforcement	planned

Research and evaluation

document	status
Briefing retrieval eval	measured 2026-08-15; reproducible with `just e2e f1`
E2E grounding eval	reference

Working on Yupana

document	what it covers
Contributing	build, test and the pre-push gate
Releasing	how release-plz cuts a release, and the crates.io lane

Historical

Kept for the record. They describe decisions already made, not how things work today.

document	what it records
Rename: hank → yupana	the 2026-08-09 rename; `hank` survives only as a compatibility name

Keyboard shortcuts

Yupana — Live Code Structure