Skip to main content

Docs Site Contract

Hand-authored contentโ€‹

  • docs/rules/**
  • docs/docusaurus/site-docs/**
  • docs/docusaurus/src/**
  • Docusaurus config and sidebar files

Generated contentโ€‹

  • docs/docusaurus/site-docs/developer/api/**
  • docs/docusaurus/build/**
  • generated inspector output under docs/docusaurus/static/*-inspector/**

Update workflowโ€‹

  1. Update authored source.
  2. Run sync/generation scripts.
  3. Run docs typecheck/link checks.