Skip to main content
Use this page before you submit a code or documentation change. The repository has build checks, provider smoke tests, documentation checks, and scripts that record screenshots and videos. These checks prevent broken links, missing images, unused media, stale generated catalog data, and examples that no longer match the interface. The provider smoke test also catches failures that static type checks cannot find, such as invalid credentials or changed SDK events.

​
Check application code

Run both commands for every code change. A page-only documentation change can use the documentation checks below instead. The project does not have a unit test suite. If you changed a provider, run its smoke test with the matching credential:

​
Preview the docs

Open http://localhost:3333. Check the page on a wide and narrow window. Follow every link you changed and run every command you added. Run the automatic documentation checks:
docs:validate checks navigation pages, feature assignments, redirects, internal links, and image paths. docs:assets:verify checks that referenced media exists and that shipped media is used by a page. Successful documentation verification finishes all three commands without errors. The local preview must also show the changed page at both window sizes, and every changed link and command must work as written.

​
Update screenshots and videos

Only record an asset when the page needs to show an interaction or a part of the interface that words cannot identify clearly. A screenshot or video should show the current interface and enough context for a reader to understand the action. Record screenshots that do not need a provider:
Record agent screenshots with:
The agent scenarios need provider credentials. Video and GIF generation also needs ffmpeg. Run a provider smoke test when the change affects that provider, its tools, or its session behavior. After recording, run npm run docs:assets:verify. Update docs/images/README.md when you add, replace, or remove an asset.

​
Update the feature catalog

The feature catalog makes sure each shipped feature has one documentation page. Its source is scripts/generate-feature-catalog.mjs, and the generated file is docs/feature-catalog.json. After you change the source, run:
Do not edit the generated JSON by hand. The catalog update succeeds when npm run docs:catalog produces no unexpected changes after a second run, and npm run docs:validate reports no missing or duplicate assignments.