Development guide

View as MarkdownOpen in Claude

Docs structure:

  • fern/docs.yml defines navigation, slugs, and theme.
  • fern/docs/pages/** contains MDX guide pages.
  • fern/docs/examples/** holds runnable code referenced via <Code src="...">.

Local dev:

  • npm run docs:dev starts the local Fern dev server.
  • npm run check validates the docs config and pages.
  • npm run docs:broken-links checks links.

Deploy:

  • npm run docs:generate runs fern generate --docs and triggers a publish.

Testing harness:

  • npm run vox:sync copies examples into voxfiles/ and writes rule configs.
  • npm run vox:upload uploads scenarios/rules to the docs test app.
  • npm run vox:test:deepgram-incoming and npm run vox:test:deepgram-outbound run call tests and print logs.