writing-docs

SKILL.md

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.

Use headings for all fields: When documenting API options or return values, each property should be its own heading. Use ### for top-level properties and #### for nested properties within an options object. Do not use bullet points for individual fields.

Guides pour la rédaction et l’édition de la documentation Remotion. À utiliser lors de l'ajout de pages de documentation, de la modification de fichiers MDX dans des packages/documents ou de la rédaction de contenu de documentation. Source : remotion-dev/remotion.

Voir l'original