AutoWiki

AutoWikiは、Factory AppとGitHub WikiでリポジトリのWikiを最新の状態に保ちます。

AutoWiki は、リポジトリ向けの包括的で構造化されたWikiを生成します。コードベースを解析し、アーキテクチャの概要、モジュールの内訳、相互リンクされたページを備えた閲覧可能なドキュメントを作成し、コードの変更に合わせて各Wikiの内容を最新に保ちます。

生成

Droid CLIで /wiki を実行して、任意のリポジトリからWikiを生成します

自動更新

/install-wiki を実行して、push ごとにAutoWikiを更新します

閲覧

Factory AppでWikiを閲覧、検索、エクスポートできます

仕組み

1. CLI から生成する

   Droid セッション内で /wiki を実行します。Droid はコードベースを解析し、アーキテクチャ、モジュール、API、規約をカバーする構造化されたMarkdownページ群を生成します。

2. Factory Appに保存する

   Cloud Sync により、生成されたWikiはFactory Appに保存され、 app.factory.ai/wiki で閲覧できるようになります。各アップロードにはバージョンが付き、時間の経過とともに変更を比較できます。

3. GitHub wiki に同期する

   GitHub でホストされているリポジトリでは、AutoWiki が生成したWikiをリポジトリの組み込みwikiタブへ任意で push できます。内部リンクは書き換えられ、サイドバーが生成され、内容が {repo}.wiki.git に push されます。

4. 最新状態を保つ

   /install-wiki を実行すると、デフォルトブランチへの push ごとにWikiを再生成する CI ワークフロー（GitHub Actions または GitLab CI）が作成されます。必要に応じてFactory Appからいつでも更新をトリガーすることもできます。

GitHub wiki sync

GitHub でホストされているリポジトリでAutoWikiがWikiを生成すると、Factory は必要に応じてその内容を GitHub の組み込み wiki タブにも同期します。これにより、チームはFactory Appを開かなくてもリポジトリページから直接Wikiを閲覧できます。同期の仕組みの詳細は Wikiを生成する を参照してください。

Factory が同期する前に、GitHub 側で wiki を初期化しておく必要があります。まだ wiki タブを使ったことがない場合は、https://github.com/{owner}/{repo}/wiki で最初のページを手動で作成し、その後 /wiki を再実行してください。

エンタープライズ制御

AutoWiki Cloud Sync

AutoWiki コンテンツをFactory Appに保存させたくない組織は、AutoWiki Cloud Sync を無効化できます。これは app.factory.ai の Settings > Enterprise Controls > AutoWiki で利用できる組織レベルのエンタープライズ制御です。

AutoWiki Cloud Sync が 無効 の場合：

• すべてのAutoWiki APIエンドポイントが組織に対して 403 を返します
• /wiki コマンドはコンテンツをFactory Appに保存しません
• CLI からの GitHub wiki 同期もスキップされます
• Factory App内のAutoWikiページにはコンテンツが表示されません

AutoWiki Cloud Sync は デフォルトで有効 です。この設定を切り替えられるのは org manager のみです。

エンタープライズ制御の動作全体については、階層設定と組織制御 を参照してください。

次のステップ

Wikiを生成する

初めてのAutoWikiを生成するためのステップバイステップガイド

AutoWiki Refreshを設定する

AutoWikiを最新状態に保つ CI アクションをインストールします

Factory Appで閲覧する

Wikiドキュメントを検索、閲覧、エクスポートします

エンタープライズ設定

組織レベルの制御がAutoWikiや他の機能をどう統制するかを学びます