tour-authoring

To create diagram tours, author *.tour.yaml files and validate them against project conventions to ensure stable IDs, proper focus references, and correct root fields. This prevents common pitfalls like empty steps and broken references.

A diagram tour is a structured walkthrough of Mermaid examples stored as *.tour.yaml files next to their diagrams. It works by guiding content structure and validating focus references to maintain consistent documentation alongside visual fixtures.

You validate broken focus references and missing root fields in tour YAML files by running validation commands that check for common pitfalls. This ensures stable IDs and proper focus references conform to documented project conventions.

Yes, you can manage test fixtures located next to Mermaid diagrams. The workflow guides content structure for *.tour.yaml files and fixtures, ensuring they conform to the repository's real contract and documented conventions.

The best way to author YAML tour files matching project conventions is to use a validation workflow that checks for empty steps and invalid focus IDs. This ensures tours match the repo's real contract rather than generic YAML styles.

Tour YAML validation fails on empty steps and invalid focus IDs when files do not conform to documented project conventions. Running preview and validation commands identifies these common pitfalls and verifies proper focus references.