Skip to Content
PhasesExportsDocs Sync Plan (Exports Phase)

Docs Sync Plan (Exports Phase)

When exports or JSON contracts change, update docs in the same implementation window.

Required docs updates

  • docs/exports/README.md
  • docs/exports/core.md
  • docs/exports/config.md
  • docs/exports/examples.md
  • docs/json/README.md (canonical JSON / --json spec)
  • docs/config/commands.md
  • docs/config/env.md (if env keys changed)

Web/API docs

  • apps/web API page(s) that describe programmatic usage and JSON output.

Checklist

  • Update import examples to namespaced API where recommended (docs/exports/core.md, docs/exports/examples.md; run pnpm run docs:sync for Nextra).
  • Mark Stable vs Advanced APIs clearly (docs/exports/core.md).
  • JSON envelope + --json documented in docs/json/README.md.
  • apps/web API page aligned with namespaces + JSON behavior (when that site ships).
  • Verify cross-links after file moves (grep broken paths in docs/).