Skip to main content

FAQ

Where should I start?

Start with getting-started, then read DOCS_INDEX and DOCS_SPINE.

How do I run docs locally?

Use:
cd docs
npx mint dev

What is the difference between runbooks, reference, and guides?

  • Runbooks: operational execution steps
  • Reference: contracts, proofs, and specs
  • Guides: practical how-tos and implementation notes

Where are known issues tracked?

See KNOWN_ISSUES.

Where do I look when something breaks?

Start with support, then use ROOT_CAUSE_ANALYSIS and relevant runbooks.

What do “stages” mean?

Stages describe pipeline progression (raw, normalized, absorbed). See glossary and PHASES.

How do I file a bug?

Open a GitHub issue with repro steps, expected vs actual behavior, date range, and links to evidence docs.

How do I choose what doc to trust first?

Prefer canonical docs in DOCS_INDEX, then section front doors: runbooks, reference, guides.

How do I know where to continue reading?

Use getting-started for sequence and support for debug flow.