ドキュメントへの貢献

Luna Flow のドキュメントは、それが説明するコードのすぐそばにあります。各リポジトリは英語で書いたマニュアルを doc/ に置き、その隣に翻訳を gettext 翻訳カタログとして保持します。このサイトはビルドのたびにすべてのリポジトリを集めるため、main にマージされた変更は、サイト自体に手を加えなくてもここに反映されます。

すべてのリポジトリに同じ規則が適用されます。

• ドキュメント規約：ファイルの置き場所と各ページの内容。
• 執筆とマークアップ：見出し、コード、数式、傍注、注意書き。
• 添付ファイル：Typst ドキュメント、PDF、画像。
• 翻訳：gettext のワークフローで各言語を英語と同期させる方法。

ツール

すべてのコマンドは、サイトリポジトリにある lunadoc が提供します。作業中のリポジトリの隣にクローンしてください。

git clone https://github.com/Luna-Flow/Luna-Flow.github.io.git
npm ci --prefix Luna-Flow.github.io

次に、自分のリポジトリで実行します。

node ../Luna-Flow.github.io/tools/lunadoc/cli.mjs update      # refresh catalogs after editing English
node ../Luna-Flow.github.io/tools/lunadoc/cli.mjs status      # translation coverage
node ../Luna-Flow.github.io/tools/lunadoc/cli.mjs check --compile

check は継続的インテグレーションで実行されるコマンドです。doc/manual を変更するプルリクエストには、update で更新した翻訳カタログも含める必要があります。

サイトのプレビュー

リポジトリをサイトの隣に置いた状態で、サイトを起動します。

cd Luna-Flow.github.io
npm run dev

リポジトリのマニフェストがない場合、ビルドには doc/conf.json を持つすべての兄弟ディレクトリが含まれるため、ローカルのプレビューで未公開の変更を確認できます。