mspec Documentation

This directory is organized using the Diátaxis framework — the same documentation taxonomy that mspec adopts for the artifacts of every change. Pick the entry point that matches what you are trying to do right now.

If you want to...	Go to	Diátaxis category
Learn mspec by walking through a first change end-to-end	tutorials/getting-started.md	Tutorial
Ship a follow-up change against an existing spec (MODIFIED / REMOVED / FR-ID gaps)	tutorials/second-change.md	Tutorial
Open the Web UI and navigate all 5 pages for the first time	tutorials/web-ui-quickstart.md	Tutorial
Solve a concrete task (typo mode, add a locale, customize the workflow)	how-to/	How-to
Look up a CLI flag, the YAML schema, or an anchor format	reference/	Reference
Look up Web UI pages, routes, themes, API endpoints, and data types	reference/web-ui.md	Reference
Understand the why behind anchors, doc_type, and the constitution	explanation/	Explanation

Map of pages

Tutorials

• tutorials/getting-started.md — install mspec, run mspec init, walk one change from new to archive.
• tutorials/second-change.md — ship a second change and meet ## MODIFIED, ## REMOVED, and FR-ID gap preservation for the first time.
• tutorials/web-ui-quickstart.md — open the Web UI, navigate the Dashboard, ChangeDetail, Spec Viewer, and Test Results pages.

How-to

• how-to/lightweight-changes.md — use typo / minor / bugfix modes to skip steps safely.
• how-to/customize-workflow.md — toggle blocking gates, subagents, enforcement flags in workflow.yaml.
• how-to/fix-anchor-errors.md — read mspec anchor check / anchor list output and fix each error class (Cases 1–7) symptom by symptom.

Reference

• reference/cli.md — every mspec subcommand, flag, and exit code.
• reference/anchors.md — the @mspec-delta 3-line block, validation rules, and CLI checks.
• reference/configuration.md — .mspec/config.yaml keys with defaults.
• reference/workflow.md — .mspec/workflow.yaml steps and enforcement flags.
• reference/doc-types.md — Diátaxis doc_type: values, per-artifact mapping, and current gaps.
• reference/web-ui.md — @mspec/web-ui pages, routes, themes, API endpoints, and TypeScript data types.

Explanation

• explanation/why-mspec.md — what problems mspec is trying to fix and the three axes that make it different.