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.

Anleitungen zum Schreiben und Bearbeiten von Remotion-Dokumentationen. Verwenden Sie diese Option, wenn Sie Dokumentseiten hinzufügen, MDX-Dateien in Paketen/Dokumenten bearbeiten oder Dokumentationsinhalte schreiben. Quelle: remotion-dev/remotion.

Original anzeigen