Contributing and Updating Docs

The public content is authored in shared-packages/docs/docsets/shared-packages.

Update workflow

1. Edit or add MDX pages in docs/docsets/shared-packages.
2. Update package metadata in docs/docsets/shared-packages/catalog.json if status, summary, or featured exports change.
3. Run:

yarn docs:build
yarn docs:validate
yarn docs:sync:local

4. Verify the docs routes in douglasebanks.com.

When docs are required

• Adding or removing a public export or subpath
• Renaming a major concept in a package
• Changing install or integration expectations
• Promoting a preview package to stable

Authoring guidelines

• Keep examples at the entrypoint or workflow level instead of documenting internal file structure.
• Use generated reference components for export-heavy pages.
• Prefer curated live demos only when they make a UI concept materially clearer.
• Link back to package changelogs or source when an API is still moving.