GitHub App

DocBot

Documentation that keeps up with your code. Every pull request gets its documentation written and committed to _docs/ in your repo, reviewed with the code that changed. Rebuilds and architecture guides wait for your approval and show the cost first.

Install free on GitHub Set up DocBot

500,000 tokens free. No credit card. No per-seat fees.

What lands in your repo

Three levels of documentation, in the pull request

DocBot reads the files a pull request changes and commits Markdown for them. Uninstall and the docs stay; they are files in your repository.

Per-file documents
_docs/<path>.md for each changed file, in output mode file or both.
Per-directory READMEs
_docs/<path>/README.md explaining the files in a directory and how they relate, in output mode directory or both.
A master index
_docs/README.md links to every generated document, whatever the mode.
Mermaid diagrams
Chosen deterministically per directory from six types: class hierarchy, state machine, data model, sequence, component dependency and module relationship. A diagram that fails validation is dropped rather than shipped broken.
Only what changed
A cache keyed by Git blob SHA means unchanged files are not regenerated or billed again.
Never triggers your CI
Every commit carries [skip ci].

You are always in control

Nothing runs without a budget in view

The approval gate is on by default on every tier. Turn it off to auto-generate.

A pull request opens
DocBot runs on opened, reopened and synchronize, skipping its own commits.
It posts an estimate
It checks the PR fits your token balance. Set require_pr_approval to true and it also waits for /docbot-approve. This is not tier-gated.
It commits the docs and reports the cost
The comment shows files processed, tokens used, percentage of allowance, cache hits, a link to the docs, and the /docbot-rerun and /docbot-feedback commands.

Full rebuilds and guides

The whole repository, one branch away

Both are behind a cost estimate you approve.

Full rebuild
Trigger it with a branch containing wai-docs-update, a PR title containing [DOCS-REBUILD], or the Rebuild Docs button in the portal. DocBot posts a cost estimate with your current usage and projected total; approve with /docbot-rebuild-approve. The request expires after 7 days, and if the work grows by more than 10% after approval DocBot asks once more. A rebuild also produces _docs/DEPENDENCIES.md: a dependency catalogue with licence data fetched from npm, PyPI and crates.io for package.json, requirements files, Pipfile, pyproject.toml, go.mod, Cargo.toml, composer.json and Gemfile.
Architecture guides
Trigger with the branch wai-guides-build, a PR title containing [GUIDES-REBUILD], or the Generate Guides button in the portal once DocBot has run once. Approve with /docbot-guides-approve. Output lands in _docs/guides/, for the projects you list under guide_projects.

Configuration

One file, and you rarely need it

.github/wai-docbot.yml, served as a template from the setup page. DocBot works with the defaults.

Read the setup guide

What you can set
output_mode, directory_overrides, allowed_base_branches with wildcards, excluded_branch_prefixes, include_extensions, exclude globs, guide_projects and guide_exclude, and the preferences include_code_links, include_examples, require_pr_approval and document_root_files.
What you cannot
The docs folder is always _docs/.
Languages
Python by AST, and JavaScript and TypeScript, HTML and CSS, C and C++, C#, Java and Kotlin, Go, Rust, Ruby, PHP, Swift, shell and PowerShell, SQL, R, Scala, Dart and Lua by pattern extraction.

Pricing

One price per account. No per-seat fees. Tokens are the only thing that changes between tiers.

DocBot tiers and monthly token allowances
Plan	Price	Tokens	Availability
Free	$0	500,000 lifetime, plus a share of a 250,000,000 monthly pool shared by all free accounts	Live
Entry	$10 / month	500,000 per month	Launching soon
Small	$50 / month	3,000,000 per month	Launching soon
Medium	$150 / month	10,000,000 per month, plus full rebuild	Launching soon
Enterprise	$500 / month	50,000,000 per month, plus full rebuild	Launching soon

No per-seat fees. One price per account, however many people work in the repositories.
14-day Marketplace trial on paid tiers, once per account. It drops back to Free at expiry. (The Service Desk trial is 7 days; the two are separate.)
Paid tiers are launching soon. They wait on GitHub Marketplace verification. The prices above are what they will be. Billing is managed in GitHub, not in the portal.
Every comment shows the balance. Files processed, tokens used, percentage of allowance and cache hits, so the free tier is never a surprise. Roughly 80 to 100 files of documentation fit in the free allowance.
Cancel any time; access runs to the end of the period. See the refund policy.

Privacy

Your code is processed, not kept

Changed files are sent over TLS to Azure OpenAI in UK South (UK West failover), used to generate the documentation, and discarded. Woden stores no source code.
No training on your code, under Microsoft's Azure OpenAI Data Protection Addendum.
Woden stores installation metadata, repository names, token counts, an audit log of runs, and plan state.
GitHub App permissions: Contents (read and write, to read source and commit docs), Pull requests (read and write, for diffs and comments), Issues (read and write, to receive slash commands), Metadata (read).
The model is gpt-5-mini with a gpt-5 failover, chosen for cost so the free tier goes a long way.
The GitHub App private key is held in Azure Key Vault; installation tokens are short-lived.

Frequently asked

Where do the docs go?

Into a _docs/ folder in your repository, always. Per-file documents at _docs/<path>.md, directory READMEs at _docs/<path>/README.md, and the index at _docs/README.md.

Does it write anything without asking?

It commits docs to the pull request's own branch when the pull request fits your token balance, so you review them with the code. Rebuilds and guides always wait for your approval. Set require_pr_approval to true to approve every pull request too.

What does it cost?

The free tier is 500,000 tokens for the life of the account plus a share of a monthly pool, with no credit card. Paid tiers from $10 a month are launching soon. Every comment shows tokens used and the balance left.

Is my code stored or used for training?

No. Changed files are processed in the request by Azure OpenAI in UK South and discarded. Microsoft's Azure OpenAI Data Protection Addendum rules out training on your content.

How do I rebuild everything?

Create a branch containing wai-docs-update, put [DOCS-REBUILD] in a PR title, or press Rebuild Docs in the portal. DocBot posts a cost estimate; approve with /docbot-rebuild-approve within 7 days.