Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Contributing

Current phase

Crua is in the planning and approval phase. Do not implement application code until the human approval gate accepts EARS 1.0.0 and all active OpenSpec proposals.

Change workflow

  1. Update the authoritative EARS document when product requirements change.
  2. Update the affected OpenSpec proposal, design, capability delta, and tasks.
  3. Run strict OpenSpec validation.
  4. Keep .beads/issues.jsonl synchronized with the approved task graph.
  5. Build the documentation site.
openspec validate --all --strict --no-interactive
python scripts/check_planning.py
python scripts/build_docs.py
mdbook build

Documentation rules

  • Do not hand-edit generated files under docs/book/.
  • Requirement IDs must remain stable and traceable.
  • Active proposal pages must not claim deployed behavior.
  • OpenSpec deltas remain under openspec/changes/ until implementation, review, and archival are complete.

GitHub Pages

Pages uses GitHub’s official artifact deployment actions. Pull requests build the site but do not deploy it. Pushes to main upload the rendered docs/book/ directory and deploy it to the protected github-pages environment. No publishing branch is created.