Project Amkdocs
204code blocks
186tested
4likely docs bugs
65 pass10 warn111 fail18 skipped
A popular open-source python library
24 pages · 38s
Engine v0.2.1 · TypeScript-aware triage
Your docs, tested on every release. Catch breakage before customers do.
DocsAlive runs the code samples in your documentation in an isolated sandbox, separates likely docs bugs from noise, and can draft a fix for your team to review.
Free for public open-source docs · Built for API and developer-tool companies
● Project A · a popular open-source Python library · mkdocs204 code blocks, grouped by outcome
65 pass
10 warn
111 fail (incl. needs context, credentials, network)
18 skipped with a reason
4 flagged as likely docs bugs
Why docs examples break
01
Docs drift silently
Every release can rename a parameter, drop an export or change an output. Nobody re-runs the hundreds of snippets in your docs to check. How documentation drift happens
02
Customers find it first
A broken quickstart can cost a new user their first hour and turns into a support ticket or a quiet churn.
03
Naive checkers cry wolf
Most snippets aren't meant to run alone. Without triage, a docs test suite is a wall of red nobody reads. How to test docs code samples
The product, unedited
Check, finding, fix and CLI, from one real run.
4 likely docs bugs in Project A
204 code blocks across 24 pages, run against the current release.
204code blocks
186executed or checked
65passed as written
4likely docs bugs
advanced-1.md:156api-drift
parameter `<param>` is not accepted by the current API
TypeError: <function>() got an unexpected keyword argument '<param>'advanced-1.md:174api-drift
advanced-2.md:180invalid-syntax
guide-1.md:118stale-output
Everything else that failed was triaged as not a docs bug (missing context, needs credentials, network) and left out of the check.
A documented keyword argument the current API rejects
advanced-1.md:156 · api-drift · likely docs bug
As documented
result = <lib>.<function>(<args>,
<param>=<value>)Sandbox output
$ python snippet.py # current release, python 3.12 Traceback (most recent call last): File "<docs-snippet>", line 13, in <module> TypeError: <function>() got an unexpected keyword argument '<param>'
Why this is classified as a docs bug
The call fails on a keyword the current API rejects (api-drift), not on missing context, credentials or network. A reader who copies this example gets an error. Pattern: TypeError: … unexpected keyword argument → api-drift, docs bug.
docs: move a rejected keyword argument to an API that accepts it
@@ advanced-1.md:168 @@
-result = <lib>.<function>(<args>, <param>=<value>)
+<obj> = <lib>.<Class>()
+result = <obj>.<function>(<args>, <param>=<value>)
```
Verification (re-run in the sandbox)
Before:
TypeError: <function>() got an unexpected keyword argument '<param>'After: executed OK on the current release
Fix PRs open as drafts. Nothing merges without a maintainer's approval. For this demo our team wrote the fix and the engine verified it.
$ docsalive scan ./project-a --execute --setup "pip install -q <package>"
DocsAlive v0.2.1 ./project-a framework=mkdocs pages=24
blocks=204 tested=186 pass=65 fail=111 warn=10 skipped=18 likely-docs-bugs=4
categories: depends-on-context=70, ok=65, runtime-error=17, missing-install-step=10, output-block=10, output-differs=9, missing-fixture=5, network-external=5, not-executable=3, fragment=3, api-drift=2, needs-credentials=2, invalid-syntax=1, stale-output=1, timeout=1
FAIL BUG? advanced-1.md:156 [python] api-drift: snippet: parameter `<param>` is not accepted by the current API
FAIL BUG? advanced-1.md:174 [python] api-drift: snippet: parameter `<param>` is not accepted by the current API
FAIL BUG? advanced-2.md:180 [python] invalid-syntax: snippet: is not valid code: invalid syntax. Perhaps you forgot a comma?
WARN BUG? guide-1.md:118 [pycon] stale-output: ran, but the documented output is from an older language version and no longer matches
# report: ./results/project-a/report.md · report.json
Real output from DocsAlive v0.2.1 on a popular open-source Python library, run October 19, 2026. Project, package, API and file names are redacted until we have reported the findings to the maintainers. Apart from that redaction, the Check, Finding and CLI views are unedited engine output. The Fix PR view shows a fix our team wrote and the engine verified. It has not been submitted upstream.
Real runs, not a demo
We pointed DocsAlive at three well-known docs sites.
Three popular open-source projects with unmodified public repositories, run against their current releases on October 19, 2026. 1,742 code blocks across 309 pages, each one executed, syntax-checked or deliberately skipped with a reason.
Project Bmintlify
1,327code blocks
927tested
7likely docs bugs
406 pass1 warn520 fail400 skipped
An open-source ai sdk with a large docs site
261 pages · 290s
Project Cdocusaurus
211code blocks
121tested
0likely docs bugs
76 pass0 warn45 fail90 skipped
A widely used open-source javascript developer tool
24 pages · 11s
"Fail" includes snippets that depend on earlier context, credentials or network. Triage keeps those out of the docs-bug count. Full methodology and findings →
How it works
From repository to reviewed fix.
One pipeline, triggered on every release, pull request or schedule.
01
Detect
Finds your docs framework (MkDocs, Mintlify, Docusaurus, plain Markdown) and every page.
02
Extract & plan
Pulls each code block with its language, page context and expected output, then plans how to test it.
03
Run in a sandbox
Executes Python, JS/TS, shell and HTTP examples in a locked-down, throwaway container.
04
Triage
Sorts every failure into a category and flags only real docs bugs.
05
Fix & verify
Drafts the change, re-runs it, and opens a draft PR for a human to approve.
What it caught
Real docs bugs in widely used open-source projects.
Each one below was flagged by the engine, then re-checked individually by our team: re-run in the sandbox and read against the source. The other flags, and which of them we haven't reviewed yet, are on the results page. Project names are withheld until we have reported the findings to the maintainers.
Project Aapi-drift
A documented keyword argument the current API rejects
The example passes a keyword argument that this function no longer accepts in the current release, so it raises TypeError. A corrected version passed when we re-ran it in the sandbox.
TypeError: <function>() got an unexpected keyword argument '<param>' advanced-1.md:156
Project Aapi-drift
The same drift in a second example
Another example on the same page passes the same keyword argument and fails the same way on the current release.
TypeError: <function>() got an unexpected keyword argument '<param>' advanced-1.md:174
Project Ainvalid-syntax
Missing comma in a dict literal
An example is missing a comma between two dictionary entries, so readers who copy it get a SyntaxError.
SyntaxError: invalid syntax. Perhaps you forgot a comma? advanced-2.md:180
Project Astale-output
Documented output from an older language version
The example ran fine, but the output printed on the page is in a format that current interpreters no longer print.
guide-1.md:118
Project Bapi-drift
Import removed upstream: an MCP client class
A cookbook imports an MCP client class from a third-party agent framework. The framework's current release no longer exports it, so the script fails at the import.
ImportError: cannot import name '<RemovedClass>' from '<agent-lib>.mcp'. Did you mean: '<OtherClass>'? cookbook-1.mdx:73
Project Bapi-drift
Import removed upstream: an agent class
An agent example imports an agent class from another third-party framework. Its current release no longer exports that class, so the example fails before it starts.
ImportError: cannot import name '<RemovedClass>' from '<agent-lib>.agent' cookbook-2.mdx:78
Designed to keep false alarms low
A docs test that's always red gets ignored. So we check the engine's work.
Across these three runs the engine flagged 11 likely docs bugs. We've reviewed 8 of them one by one: 6 are real docs bugs and 2 are false alarms. The other 3 haven't been reviewed yet, so we don't count them either way. It's a small sample, not a guarantee for your docs.
Flagged · v0.2.111likely docs bugs, 3 runs
Reviewed · 8 of 116confirmed · 2 false alarms
| Engine flags (v0.2.1) | Confirmed | False alarm | Not yet reviewed |
|---|---|---|---|
| Project A: 4 | 4 | 0 | 0 |
| Project B: 7 | 2 | 2 | 3 |
| Project C: 0 | 0 | 0 | 0 |
| Total: 11 | 6 | 2 | 3 |
Every flag and its review status is listed on the results page. No AI model was involved in the engine's classifications.
Product
Built to help docs teams trust their examples.
Executes, not just lints
Python, JavaScript, TypeScript, shell, curl and raw HTTP blocks run for real against the version you ship.
Triage that filters noise
Fragments, placeholders, credentials and flaky networks are recognized and kept out of the docs-bug count.
Fixes as draft PRs
Likely docs bugs can get a proposed change, re-run in the sandbox, waiting for your review.
OpenAPI checks
Validates $ref integrity across your spec. 68 operations and 87 examples checked in one pass on Project B.
Lives in your CI
Runs on pull requests, releases or nightly. Results appear as a check with line-level annotations.
Docs health badge
Show readers your examples are tested, with a badge that shows the result of the latest run.
Security & trust
Your code runs in a box we throw away.
Every run happens in a fresh, unprivileged container. Source checkouts are deleted when the run ends, and proposed changes reach your branches only when a person on your team merges them.
- Isolated execution: read-only root filesystem, all Linux capabilities dropped, no privilege escalation, CPU, memory and process limits.
- No code retention: repository checkouts are deleted after each run. Reports keep only file paths, line numbers and short error excerpts.
- Least privilege: the GitHub App asks only for the permissions it needs to read docs, post checks and open draft PRs.
- Human in the loop: fixes open as draft pull requests. DocsAlive is designed not to merge anything. You review and merge.
Pricing
Free for open source. Simple for teams.
Pick a plan by how many docs pages you have and how often you ship.
Open source
Public open-source projects only.
$0 / month
Apply for OSS access
- OSI-licensed public repo (1)
- Up to 100 docs pages
- Weekly runs
- Check annotations & report
- Docs health badge
- Community support
Team
One product's docs, kept honest every night.
$299 / month
Choose Team
- Private or public repo (1)
- Up to 150 docs pages
- Nightly runs + on pull requests
- Draft fix PRs, re-run in the sandbox
- Line-level PR check annotations
- Email support
Growth Recommended
Several products or SDKs that ship often.
$699 / month
Choose Growth
- Up to 5 repos, 500 docs pages
- Runs on every release, PR and nightly
- OpenAPI reference checks
- Everything in Team
- Priority support
Scale
Large doc sets, custom runtimes, procurement.
from $1,499 / month
Contact us
- Custom page and repo limits
- Custom runner images & schedules
- DPA, security review, invoicing
- Everything in Growth
- Dedicated support channel
Prices in USD, billed monthly, and subject to change (see the Terms). Team and Growth are paid online through Stripe. After you subscribe, we contact you to set up DocsAlive on your docs with your team (onboarding review). Features may change, and no uptime or support-response SLA applies unless agreed in writing.
Free Docs Health Check
Find out which of your examples still work.
Send us a public repository. Our team runs DocsAlive on its docs and emails you the real report within 2 business days. Free, no signup.