Guides for writing and editing Remotion documentation. Use when adding docs pages, editing MDX files in packages/docs, or writing documentation content.
Tasks
Create a new .mdx file for the API in packages/docs/docs and add the page entry to packages/docs/sidebars.ts
Document each top-level API property using ### headings and each nested property using #### headings instead of bullet points
Run bun render-cards.ts inside packages/docs to generate social media preview cards for the new or edited page
Validate MDX syntax, twoslash snippets, and links by running bun run build-docs from the monorepo root
Inputs
packages/docs/docs directory for .mdx documentation files
packages/docs/sidebars.ts for sidebar navigation registration
packages/docs/components/demos/index.tsx for implementing interactive demos
Outputs
Generated .mdx documentation pages
Compiled and validated documentation site output
Social media preview cards generated by render-cards.ts
Limitations and checks
One API per page: multiple APIs must not be combined on a single documentation page
Public API only: internal, private, or implementation details must not be documented
Demos must be pre-implemented in packages/docs/components/demos/index.tsx before referencing the Demo component
Confirm each new documentation page covers exactly one public API and does not reference internal or private APIs
Verify all API option and return value fields use ### or #### headings rather than bullet points
Run bun run build-docs to validate MDX syntax, twoslash snippets, and broken links before submitting changes
Ensure bun render-cards.ts has been executed after adding or editing any documentation page
AI Search
Find projects, verify facts, compare options, or turn a complex need into an actionable plan
Try a searchA click only fills the search box; you stay in control