Comfy-Org/docs

Comfy‑Org/docs とは？

このリポジトリには、AI 画像生成パイプライン（例：Stable Diffusion）を構築するためのビジュアルノードベースインターフェースである ComfyUI の公式ドキュメントサイトが含まれています。ドキュメントは、MDX ファイルを多言語ウェブサイト（https://docs.comfy.org/）にレンダリングする静的サイトジェネレーターである Mintlify で構築されています。

主な目的

• ユーザー向けドキュメントを構成するソース Markdown/MDX ファイルを保存します。
• ローカルで変更をプレビューするスクリプトを提供します（npm i && npm run dev）。
• OpenAI 互換の翻訳モデルを使用して、英語ドキュメントを複数の言語（中国語、日本語、韓国語など）に自動翻訳します。
• 組み込みノードのドキュメントを別の Comfy-Org/embedded-docs リポジトリと同期させます。
• OpenAPI 仕様から API リファレンスページを生成します。

主な機能とワークフロー

機能	仕組み	重要性
ローカルプレビュー	npm run dev で MDX ファイルをレンダリングする開発サーバーが起動します。	コントリビューターはマージ前に変更をすぐに確認できます。
自動 i18n	npm run translate が翻訳 API（OpenAI 互換）を呼び出し、翻訳された MDX を言語フォルダーに書き込みます。front-matter のハッシュがファイルが最新かどうかを追跡します。	手動翻訳なしでドキュメントを複数言語で同期できます。
用語集と用語の一貫性	3 層システム（preserve_terms、glossary/frontend、glossary/overrides）により、翻訳全体で技術用語が一貫して保たれます。	多言語ドキュメントでの混乱や矛盾した用語を防ぎます。
API リファレンス生成	npx @mintlify/scraping@latest openapi-file <path> が OpenAPI 仕様を MDX エンドポイントページに変換します。	ComfyUI のバックエンドサービスを使用する開発者向けに、最新で検索可能な API ドキュメントを提供します。
リダイレクトの安全性	ファイル名が変更された場合、PR には docs.json に redirects 配列を含める必要があります。欠落している場合、GitHub Action が PR を失敗させます。	再構成後も古いリンクが機能し続けることを保証します。
同期所有ファイルの保護	特定のファイル（例：openapi‑v2.yaml、生成されたルーターページ）は同期のたびに自動生成されます。ワークフローは、これらの保護されたパスを編集する PR をブロックします。	自動生成されたコンテンツの誤った上書きを防ぎます。
貢献フロー	PR を開く → Vercel が https://docs.comfy.org/ に自動デプロイ → レビュアーがマージ。	ドキュメント更新のためのシンプルで迅速なフィードバックループ。

誰が使うべきか？

• ComfyUI ユーザー：インストールガイド、ノードリファレンス、ワークフロー例を探している方。
• 開発者：OpenAPI 仕様や API 使用例が必要な方。
• 翻訳者：新しい言語を追加したい方（issue を開いてください。リポジトリが一括翻訳を自動処理します）。
• コントリビューター：ドキュメントの改善、チュートリアルの追加、用語の修正をしたい方。

始め方

1. リポジトリをクローンします。
2. npm i を実行し、次に npm run dev を実行してローカルでサイトを表示します。
3. ルート（英語）または言語サブフォルダーで MDX ファイルを編集または追加します。
4. 準備ができたら、ブランチをプッシュして PR を開きます。マージ後、Vercel が変更を公開します。
5. 新しい言語が必要な場合は、issue を開いてください。メンテナーが translation-config.json に追加し、一括翻訳スクリプトを実行します。

---

要約： Comfy‑Org/docs は、ComfyUI AI ワークフローツールの多言語ドキュメントのソースコードと自動化ハブであり、簡単なローカルプレビュー、自動翻訳、API リファレンス生成、安全な貢献プロセスを提供します。