writing-docs

Guidelines and templates for writing Remotion API documentation in MDX format. Documentation lives in packages/docs/docs as .mdx files. Breadcrumb ( crumb ) : If a documentation page belongs to a package, add crumb: '@remotion/package-name' to the frontmatter. This displays the package name as a breadcrumb above the title. One API per page : Each function or API should have its own dedicated documentation page. Do not combine multiple APIs (e.g., getEncodableVideoCodecs() and getEncodableAudioCodecs() ) on a single page. Public API only : Documentation is for public APIs only. Do not mention, reference, or compare against internal/private APIs or implementation details.