# Keep a wiki of your codebase that updates after every merge

> Early access: keep a wiki of your codebase as Markdown in your own repository, updated after each merge through a pull request your team reviews.

Early access, for developers.

SHIP writes a wiki of your architecture, modules and conventions as Markdown in your repository. It updates the pages a merge changes, through a pull request you review.

- **For:** Developers joining or maintaining a codebase nobody fully remembers.
- **Instead of:** A docs folder last updated by someone who left.
- **Runs today:** Schedule an automation with your own documentation prompt, and each run opens a pull request that updates your docs on the cadence you set.

## Generate it once, then let merges update it

1. **Point SHIP at a repository.** SHIP reads the code and writes an overview, one page per module, and the conventions it finds. The first version arrives as a pull request.
2. **Review it like code.** Edit the pages, delete what is wrong and merge. Every later change to the wiki goes through review the same way.
3. **Let merges keep it current.** After a merge, SHIP updates only the pages that change touched, in a small pull request you approve.

## Give your agents the same briefing as your engineers

- **Brief every mission from the wiki.** The Planner reads the relevant pages before it plans a change, so missions start from what your team agreed.
- **Link every page to the code.** Each page links to the files it describes, so a reader can check a sentence against the source.
- **Own every page.** The wiki is Markdown in your repository, and it stays there if you stop using SHIP.
- **Choose the model that writes it.** Pick the harness and model for the wiki, on your own keys, billed at your own rates.

## Compare SHIP with Devin and Factory

- **SHIP:** In early access: Keeps the wiki as Markdown in your repository, and changes it through pull requests you review.
- **SHIP:** In early access: Gives the Planner the relevant pages before each mission.
- **SHIP:** Bills per mission: one credit covers one mission of up to 3 agent-hours, and your own provider bills model usage. ([Key facts](https://letsship.ai/about#key-facts))
- **Devin:** Generates a wiki with architecture diagrams, source links and summaries for each connected repository with DeepWiki, configurable with a .devin/wiki.json file. ([DeepWiki](https://docs.devin.ai/work-with-devin/deepwiki))
- **Devin:** Uses the wiki to answer questions about your codebase in Ask Devin. ([DeepWiki](https://docs.devin.ai/work-with-devin/deepwiki))
- **Factory:** Generates structured Markdown pages covering architecture, modules, APIs and conventions with AutoWiki, and can sync them to a GitHub repository's Wiki. ([AutoWiki](https://docs.factory.com/software-factory/wiki/overview))
- **Factory:** Regenerates the wiki on every push to the default branch, through a CI workflow it sets up. ([Automatic refresh](https://docs.factory.com/software-factory/wiki/auto-refresh))

Last reviewed October 1, 2026, from each product's own pages.

## Frequently asked questions

### Is the codebase wiki available today?

Not yet: the generated wiki that updates after every merge is in early access. Today, schedule an automation with your own documentation prompt, and each run opens a pull request that updates your docs on the cadence you set. [Automations API](https://letsship.ai/docs/api/automations)

### Where does the wiki live?

SHIP's codebase wiki lives in your own repository as Markdown, in a folder you choose. Anything that renders Markdown can show it.

### When is Devin's DeepWiki or Factory's AutoWiki the better fit?

Devin fits a team that wants a generated wiki its agent also uses to answer questions about the code, through DeepWiki and Ask Devin. Factory fits a team that wants AutoWiki pages regenerated by CI on every push to the default branch, optionally synced to the repository's GitHub Wiki. SHIP fits when each wiki change should arrive as a pull request your team reviews before it merges.

### Do SHIP's agents read my repository's docs today?

Yes: on every mission the Planner, Reviewer and Tester read your repository's CLAUDE.md, including an AGENTS.md it imports with a bare @AGENTS.md line. A file at .ship/agents/<role>.md adds conventions for one role. [Agent prompts](https://letsship.ai/docs/configuration/agent-prompts)

## Start your wiki with one pull request

Join early access and get the first version of your wiki as a pull request.

Source: https://letsship.ai/platform/codebase-wiki