Factory Wiki は、リポジトリ向けの包括的で構造化されたドキュメントを生成します。コードベースを解析し、アーキテクチャの概要、モジュールの内訳、相互リンクされたページを備えた閲覧可能な wiki を作成し、コードの変更に合わせてその内容を最新に保ちます。Documentation Index
Fetch the complete documentation index at: https://factory-docs-auto-sync-jp-docs.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
生成
CLI で
/wiki を実行して、任意のリポジトリから wiki を生成します自動更新
/install-wiki を実行して、push ごとに wiki を更新します閲覧
Factory アプリで wiki を読んだり、検索したり、エクスポートしたりできます
仕組み
CLI から生成する
Droid セッション内で
/wiki を実行します。Droid はコードベースを解析し、アーキテクチャ、モジュール、API、規約をカバーする構造化された Markdown ページ群を生成します。Factory cloud にアップロードする
生成された wiki は Factory cloud にアップロードされ、
app.factory.ai/wiki で閲覧できるようになります。各アップロードにはバージョンが付き、時間の経過とともに変更を比較できます。
GitHub wiki に同期する
GitHub でホストされているリポジトリでは、wiki はリポジトリの組み込み wiki タブへ自動的に push されます。内部リンクは書き換えられ、サイドバーが生成され、内容が
{repo}.wiki.git に push されます。GitHub wiki sync
GitHub でホストされているリポジトリで wiki を生成すると、Factory は必要に応じてその内容を GitHub の組み込み wiki タブにも同期します。これにより、チームは Factory アプリを開かなくてもリポジトリページから直接 wiki を閲覧できます。同期の仕組みの詳細は Wikiを生成する を参照してください。Factory が同期する前に、GitHub 側で wiki を初期化しておく必要があります。まだ wiki タブを使ったことがない場合は、
https://github.com/{owner}/{repo}/wiki で最初のページを手動で作成し、その後 /wiki を再実行してください。エンタープライズ制御
Wiki Cloud Sync
wiki コンテンツを Factory cloud に保存させたくない組織は、Wiki Cloud Sync を無効化できます。これは app.factory.ai の Settings > Enterprise Controls > Wiki で利用できる組織レベルのエンタープライズ制御です。 Wiki Cloud Sync が 無効 の場合：- すべての wiki API エンドポイントが組織に対して 403 を返します
/wikiコマンドはコンテンツを Factory cloud にアップロードしません- CLI からの GitHub wiki 同期もスキップされます
app.factory.ai/wikiの Webビューアにはコンテンツが表示されません
次のステップ
Wikiを生成する
初めての wiki を生成するためのステップバイステップガイド
自動更新を設定する
wiki を最新状態に保つ CI アクションをインストールします
Web アプリで閲覧する
wiki ドキュメントを検索、閲覧、エクスポートします
エンタープライズ設定
組織レベルの制御が wiki や他の機能をどう統制するかを学びます