docs

README

Find your way around nova-sprint

Welcome! If you are wondering whether nova-sprint would help your AI team, start with the project introduction. You can check your installation and find the path to a first card without learning the table layout or reading a specification.

nova-sprint builds on Nova Tools. The system coordinates workers across fleet machines, from ready cards through review and landing.

Start here

Your next question	Where to go
What does nova-sprint do?	Project introduction
Can I watch a sprint doing real work?	Live dashboard and the README tour
How do I get started?	Getting started
What can I try before connecting a team?	First-lap note
How does the system keep work moving?	Follow a card
What are cards, streams, dependencies, and sentinels?	Workflow glossary, then the sprint contract
What do I do as the coordinator?	Coordinator's guide
Which verbs, in what order, for a situation?	Coordinator's playbook (nova-sprint help playbook)
What do I check before I finish a card?	Before-finish checklist
How do I coordinate at low cost?	dispatcher
How do commands connect to a store or server?	Environment reference
What is the exact command?	Command reference
How do I open the dashboard?	Dashboard guide and specification
How do I contribute a change?	Contributing

Command references, implementation notes, and recorded results describe the code or revision they name. Use the help shipped with your build for exact command spelling. A planned feature in a design note is not an executable example.

When you need the details

Reference	What it helps you understand
Sprint contract	Cards, dependencies, scheduling, review, landing, and the rules each state change follows.
Coordinator credentials	How locally executed configuration commands get the credentials they need.
Environment variables	How commands select a twin, direct store, server, and actor.
Work tree format	The GitHub issue mirror, the fields it preserves, and import/verify behaviour.
Work language	The small data grammar used to read tree files without evaluating them.
Executable examples	Exact command transcripts checked by tests.
Test harness	Shared helpers for contributors writing command tests.
State-machine models	What the TLA+ models explore and how to interpret their results.
Brand and voice	The robot friends, name, colours, and writing style.
Asset provenance	Where the artwork and font came from.
Recorded reviews	Feedback from earlier versions, preserved with its original context.

The specs keep precise rules, owner quotations, and examples that tests read. Those details are there when you need them. The guides explain the same workflow from the point of view of the person using it.

Documentation

Overview

Package docs compiles this repository's documentation data into the binary, so a built binary can answer which fixes it carries with no file beside it (docs/SPEC-SPRINT.md section 11, the version verb), and print the coordinator's playbook (nova-sprint help playbook).

Index

• Variables

Variables

var CoordinatorPlaybook string

CoordinatorPlaybook is docs/COORDINATOR-PLAYBOOK.md compiled in, the page `nova-sprint help playbook` prints: the coordinator's workflows, each the verbs in order. A test (cmd/nova-sprint/playbook_test.go) holds these bytes equal to the file, and every verb, flag and usage line the page names to the help, so the page cannot go stale.

var FixesSexp []byte

FixesSexp is docs/fixes.sexp compiled in, the fixes ledger `nova-sprint version --features` and `--has` read. It is decoded with the same parser `make roadmap` uses (nova-tools pkg/roadmap), so the binary and the page agree; a test holds these bytes equal to docs/fixes.sexp, so a stale embed cannot ship.