Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.16 KB

File metadata and controls

35 lines (26 loc) · 1.16 KB
paths
src/docs/**
src/components/**/README.md
src/helpers/**/README.md
README.md

Documentation

Commands

  • Run npm run markdownlint after changes (add -- --fix to autofix).
  • Run mkdocs build and mkdocs serve to build and serve the documentation
  • To verify a rendered component or the docs previews in a real browser (navigate, click, screenshot, inspect the running docs site), drive host Chrome through the chrome-host MCP. See AI Integration.

See Commands.

Conventions

  • Documentation is built with Material for MkDocs and Docoff (live, runnable component previews). Component docs live in each component's README.md; guides and foundations live under src/docs/.
  • New pages must be wired into the navigation in mkdocs.yml.
  • Use relative links between docs.

Reference