writing-docs

作成者: remotion-dev

Remotion APIドキュメントをMDX形式で記述するためのガイドラインとテンプレート。packages/docs/docsにAPIごとに1つの.mdxファイルを作成し、sidebars.tsに追加して、bun render-cards.tsを実行しソーシャルプレビューカードを生成します。APIプロパティには###見出し(箇条書きではなく)を使用し、オプションパラメータには?サフィックスを追加し、デフォルト値を説明文に自然に含めます。twoslash検証を使用した型安全なコードスニペットを推奨し、インポートを隠すために// ---cut---を使用し、常にtitle属性を...に追加します。

npx skills add https://github.com/remotion-dev/remotion --skill writing-docs

remotion-devのその他のスキル

remotion-best-practices
remotion-dev
Remotion - Reactでの動画作成のベストプラクティス
official
add-expert
remotion-dev
Remotionのエキスパートページに新しいエキスパートを追加する
official
add-sfx
remotion-dev
@remotion/sfxに新しい効果音を追加する
official
docs-demo
remotion-dev
Remotionのドキュメントにインタラクティブなデモを追加します。ドキュメントページ用の新しい<Demo>コンポーネントを作成する際に使用します。
official
fix-dependabot
remotion-dev
DependabotのPRを修正するには、依存関係のすべてのモノレポインスタンスを更新し、bun installを実行してプッシュします
official
make-pr
remotion-dev
プルリクエスト作成を自動化し、フォーマット済みコミットとブランチ管理を行います。メインブランチにいないことを確認し、必要に応じてフィーチャーブランチを作成します。影響を受けるすべてのパッケージに対してOxfmtコードフォーマットを実行してからコミットします。package.jsonのパッケージ名を使用してコミットとPRタイトルをフォーマットします(例:「@remotion/shapes : Add heart shape」)。変更をプッシュした後、gh CLIを使用して自動的にプルリクエストを開きます。
official
pr-name
remotion-dev
PRの正しい命名
official
remotion-best-practices
remotion-dev
Remotion - Reactでの動画作成のベストプラクティス
official