Factory.ai Logo

AutoWiki

AutoWiki generates comprehensive, structured Wikis for your repositories.

AutoWiki generates comprehensive, structured Wikis for your repositories. It analyzes each codebase and produces browsable documentation with architecture overviews, module breakdowns, and cross-linked pages, then keeps each Wiki current as your code changes.

AutoWiki repository overview in the Factory App
Generate

Run /wiki in the Droid CLI to produce a Wiki for any repo

Generate
Auto-refresh

Run /install-wiki to refresh Wikis on every push

Auto-refresh
Browse

Read, search, and export Wikis in the Factory App

Browse

How it works

  1. 1
    Generate from the Droid CLI

    Run /wiki inside a Droid session. Droid analyzes the codebase and produces a set of structured markdown pages covering architecture, modules, APIs, and conventions.

  2. 2
    Store in the Factory App

    Cloud Sync stores the generated Wiki in the Factory App, where it becomes browsable at app.factory.ai/wiki. Each sync is versioned so you can compare changes over time.

  3. 3
    Sync to GitHub Wiki

    For GitHub-hosted repositories, AutoWiki can push generated Wikis to the repo's built-in GitHub Wiki tab. Internal links are rewritten, a sidebar is generated, and the content is pushed to {repo}.wiki.git.

  4. 4
    Keep it current

    Run /install-wiki to create a CI workflow (GitHub Actions or GitLab CI) that regenerates the Wiki on every push to the default branch, or trigger a refresh from the Factory App at any time.

GitHub Wiki sync

When AutoWiki generates a Wiki for a GitHub-hosted repository, Factory can optionally sync the content to GitHub Wiki. Your team can browse the same documentation directly from the repository page without visiting the Factory App. For details on how the sync works, see Initialize a Wiki.

Generated AutoWiki content synced to GitHub Wiki
Note

GitHub requires GitHub Wiki to be initialized before Factory can sync to it. If you haven't used GitHub Wiki before, create the first page manually at https://github.com/{owner}/{repo}/wiki, then re-run /wiki.

Enterprise Controls

AutoWiki Cloud Sync

Organizations that need to prevent AutoWiki content from being stored in the Factory App can disable AutoWiki Cloud Sync. This is an org-level enterprise control available in the Factory App under Settings > Enterprise Controls.

AutoWiki Cloud Sync enterprise control in Factory settings

When AutoWiki Cloud Sync is disabled:

  • All AutoWiki API endpoints return 403 for your organization
  • The /wiki command will not store content in the Factory App
  • GitHub Wiki sync is also skipped from the Droid CLI
  • The AutoWiki page in the Factory App shows no content

AutoWiki Cloud Sync is enabled by default. Only org managers can toggle this setting.

For more on how Enterprise Controls work, see Enterprise Controls & Managed Settings.

Related resources

Initialize a Wiki

Generate a Wiki for your repository from the Droid CLI.

Wiki Browser

Browse, search, and export generated Wikis in the app.