AutoWiki

A living wiki
for every repo.

Factory reads your codebase and generates a browsable wiki - architecture, modules, APIs, conventions - then keeps it current on every push. Browse it in the Factory app, your GitHub wiki tab, or export to markdown.

Generate a wiki

Install auto-refresh

Three surfaces, one source

Read it wherever your team already works.

One generation run produces markdown that renders locally, in the Factory web app, and in your GitHub wiki tab. Switch contexts without switching documentation.

CLI

/wiki in a Droid session

Generates markdown into a local droid-wiki/ folder, then uploads the contents to Factory cloud. Runs from any repository, on any branch.

Factory app

app.factory.ai/wiki

Browse, search, and version-compare wikis for all your repos in one place. Full-text search, table of contents, and markdown export built in.

GitHub wiki

{repo}.wiki.git sync

For GitHub-hosted repos, the wiki is flattened, link-rewritten, and pushed to the built-in wiki tab so your team can read it without leaving GitHub.

How generation works

Four passes. One wiki that actually describes your code.

First run analyzes the repo end-to-end. Every run after uses incremental mode and only updates pages affected by changes since the last generation - so refresh is fast, even on large monorepos.

Step 01

Codebase analysis

Reads source files, configuration, tests, and existing documentation to understand project structure, dependencies, and conventions.

Step 02

Page generation

Produces a set of structured markdown pages organised by topic - architecture, modules, APIs, setup, conventions - with cross-links between them.

Step 03

Visual screenshots

When a QA skill is installed, Factory launches the app and captures screenshots of web UIs and TUIs to embed directly in the wiki.

Step 04

Upload + GitHub sync

Uploads the markdown and images to Factory cloud, then pushes a flattened version to {repo}.wiki.git for GitHub-hosted repositories.

Auto-refresh

/install-wiki scaffolds the workflow. Merge the PR and you're done.

One command detects your CI framework, creates the appropriate workflow file (GitHub Actions or GitLab CI), and opens a PR for you to review. Add FACTORY_API_KEY as a secret, merge, and the wiki regenerates on every push to the default branch.

>
Triggers on push to the default branch
>
Installs the Droid CLI via the official installer
>
Runs /wiki headlessly with high autonomy
>
Customizable - path filters, cadence, timeouts

.github/workflows/droid-wiki-refresh.yml

YAML

name: Droid Wiki Refresh

on:
  push:
    branches: [main]

jobs:
  wiki-refresh:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install Factory Droid
        run: curl -fsSL https://app.factory.ai/cli | sh
      - name: Generate wiki
        run: droid exec --auto high "/wiki"
        env:
          FACTORY_API_KEY: ${{ secrets.FACTORY_API_KEY }}

Web viewer

Read, search, and refresh wikis from one place.

app.factory.ai/wiki lists every wiki you've generated and gives each one a reader surface tuned for browsing, searching, and regenerating.

Full-fidelity markdown

Rendered with syntax-highlighted code blocks and preserved structure.

Table of contents

Sidebar outline of the current page for quick navigation.

Breadcrumbs

Hierarchical navigation shows your position in the page tree.

Full-text search

Search across every page in the wiki in one keystroke.

Version history

Browse previous generations and compare how docs evolve.

Markdown export

Download any wiki as a set of markdown files.

Batch refresh

Select multiple repos, refresh them in parallel on a Droid Computer.

Cloud or local

Run generation on your local machine, or on a cloud template or Droid Computer.

GitHub wiki sync

Your team reads docs in GitHub. We meet them there.

For GitHub-hosted repositories, every wiki generation is also pushed to the repository's built-in wiki tab.

Initialize the wiki tab once at github.com/{owner}/{repo}/wiki before the first sync.

Flattens hierarchy

overview/architecture.md becomes overview--architecture.md to fit GitHub's flat wiki format.

Rewrites internal links

Every internal link is rewritten to point to the flattened filenames so navigation works identically.

Generates sidebar + home

_Sidebar.md is produced from the wiki tree; Home.md is produced from your root page.

Clones, replaces, pushes

Factory clones {repo}.wiki.git, replaces all content atomically, and pushes - every generation is a clean state.

Versioning

Every generation is a versioned run.

Compare how documentation evolved between releases. Capture a point-in-time snapshot before refactors. Roll back to a prior version in the viewer.

Run metadata

Commit hash

abc1234

Branch

main

Dirty

false

Droid CLI version

1.10.2

Timestamp

2026-04-28T09:22:01Z

Enterprise controls

Turn cloud sync off. Keep every other feature on.

Organizations that cannot store wiki content in Factory's cloud can disable Wiki Cloud Sync at the org level. When disabled, /wiki skips the upload and GitHub wiki sync, and the web viewer returns no content for your org.

Wiki Cloud Sync docs Hierarchical settings

All wiki endpoints

Return 403 for your organization when cloud sync is off.

CLI /wiki

Generates locally but skips the cloud upload step.

GitHub wiki sync

Also skipped when cloud sync is off - no content leaves your infra.

Org manager gate

Only org managers can toggle Wiki Cloud Sync.

Get started

Generate your first wiki. Then set it to refresh on push.

cd /path/to/your/project
droid
> /wiki