Zum Inhalt springen
Kitbay
Einreichen
Skill

writing-docs

NOASSERTIONAktualisiert am 11. Nov. 202672.390GitHub-Sterne

A contributor skill in the Remotion repository for writing and editing Remotion's documentation. New pages are MDX files added to the docs sidebar in the right order.

Was der Skill vermittelt

A contributor skill in the Remotion repository for writing and editing Remotion's documentation. New pages are MDX files added to the docs sidebar in the right order. The rules cover one public API per page, linked API names with brackets for functions and components, a heading for each option instead of bullet lists, sentence case, short wording without bold terms, version markers only in headings, and a compatibility table before the See also section. It explains how to audit existing pages for these points and how to generate and upload social preview cards with a repository script, which needs the docs storage credentials.

Funktionen

  • Add a new Remotion docs page and sidebar entry
  • Apply Remotion's docs style rules
  • Audit existing docs pages for missing markers
  • Generate social preview cards for pages