Overview
Docsmith documentation
Docsmith watches your repositories, finds the documentation a change invalidated, and drafts the update. There are three ways to use it: the GitHub app, the CLI, or the API directly. Everything below assumes an account, which is free and takes a minute.
Start here
Quickstart
From an empty account to a first draft in about four minutes.
Integration
GitHub app
Permissions requested, path scoping, and how drafts become pull requests.
Integration
CLI
Run a sync against a local working tree, from a hook or a CI job.
Reference
API reference
Authentication, the sync endpoint, errors and rate limits.
Reference
Webhooks
Events, payload shapes and signature verification.
Concepts
Five words are used consistently throughout these pages and in the product.
| Term | Meaning |
|---|---|
| Repository | A connected source repository. Docsmith reads code from anywhere in it and writes drafts only into the paths you nominate. |
| Page | One documentation page under watch. Counted against your plan limit whether or not it is ever flagged. |
| Sync | One page analysed against one change. This is the billable unit. A commit that reaches four pages uses four syncs. |
| Finding | A specific passage the change invalidated, with the passage quoted verbatim from the page and a reason. |
| Draft | The complete rewritten page. Always the whole page, never a fragment, so it can be committed as-is. |
Verdicts
Every sync ends in one of two verdicts.
- current — nothing on the page depends on what changed. No draft is produced and no diff is generated. Most syncs end here, and that is the intended behaviour.
- stale — at least one passage is now wrong, every reported passage was located verbatim on the page, and the draft differs from the original.
If a model proposes findings but the resulting draft is byte-identical to the original, the verdict flips back to current. Docsmith does not open a pull request that only reflows prose.
Limits
| Limit | Free | Team | Business |
|---|---|---|---|
| Repositories | 1 | Unlimited | Unlimited |
| Pages watched | 25 | 2,000 | 25,000 |
| Syncs per month | 30 | 1,500 | 15,000 |
| API requests | 60 / hour | 600 / hour | 3,000 / hour |
| Max diff size | 24,000 characters on every plan | ||
| Max page size | 40,000 characters on every plan | ||
There is no overage billing. When a monthly limit is reached, syncs stop until the counter resets on the first of the month. Full pricing is on the pricing page.