Free tier live

Your docs are
broken. We find
what.

Scans your docs for broken code examples, stale API references, and dead links — surfaced as PR checks and a live dashboard.

Get started freeHow it works
$ zivodoc scan --repo your-org/docs
Cloning repository...
Crawling docs site... found 1,847 pages
Extracting checkable items...
    Code blocks... 423 examples
    API refs... 189 endpoints
    Links... 2,341 total
Detected:
    Spec:       openapi.yaml (OpenAPI 3.1)
    Languages:  js, ts, json, yaml, bash
✓ 4,800 items across 1,847 pages. Ready to validate.

32

Broken examples

14

API mismatches

23

Dead links

The Problem

Docs rot silently after every code change. Nobody catches it until users complain and churn.

Broken code examples

Code examples drift the moment your code does. Imports change, APIs deprecate, output formats shift. Your getting-started guide silently becomes a getting-stuck guide.

Stale API references

Your OpenAPI spec says one thing, your docs say another. Required params marked optional, missing fields, wrong response schemas. Users hit errors your docs promised wouldn't happen.

Dead links everywhere

Pages get renamed, sections get moved, external resources disappear. Every dead link is a user who clicked, got a 404, and lost trust in your product.

How It Works

From broken docs to passing CI — fully automated

01

Connect

Point zivodoc at your repo and docs site. Works with any static site generator, docs framework, or custom setup. One-line CI integration to run on every push.

02

Scan & Validate

zivodoc crawls every page, extracts code blocks, API references, and links. JS examples run in a WASM sandbox; JS / TS / JSON / YAML are syntax-checked; API references are validated against your OpenAPI spec.

03

Review & Resolve

Findings appear in your dashboard with file, line, and severity. The GitHub App posts a check + sticky comment on every PR so reviewers see broken docs alongside the diff — no separate workflow.

02 / Live Dashboard

See everything that's broken — in one place

zivodoc — stripe/stripe-docs

Pages scanned

1,847

Code examples

391/423

API endpoints

175/189

Links checked

2,318/2,341

12 Critical
8 Warning
3 Info
23 issues found
FileIssue typeSeverityLine
/guides/quickstart.mdBroken codecritical:42
/api/authentication.mdStale API refcritical:18
/guides/webhooks.mdDead linkwarning:67
/api/errors.mdHeading skipwarning:23
/guides/pagination.mdBroken codecritical:91
/api/tokens.mdStale API refinfo:55
23 findings · 1m 42sOpen in dashboard →

By the Numbers

What the scanner actually does.

21finding categories the scanner ships with
JSexamples executed in a WASM sandbox
CIGitHub Action and CLI for any provider
5 minto run your first scan, free

01 / Capabilities

Everything your docs need to stay accurate

01

Execution

Code Block Validation

Every JavaScript example in your docs runs in an isolated WASM sandbox to catch ReferenceError, TypeError, and runtime crashes. JS, TypeScript, JSON, and YAML blocks are also syntax-checked, so broken examples get flagged before they hit your users.

JavaScript runtime in WASMJS / TS syntax checkingJSON / YAML validationPer-block error context
02

Accuracy

API Validation

Compares every API reference in your docs against your OpenAPI spec. Catches wrong params, missing fields, and outdated schemas. Supports OpenAPI 3.0, 3.1, and Swagger 2.0.

03

Reliability

Dead Link Detection

Scans every internal and external link. Finds 404s, redirect chains, and anchors that no longer exist.

04

Hygiene

Secret & Quality Scan

Detects leaked API keys, internal-only URLs, missing alt text, broken images, heading skips, TODO markers, and placeholder text — the small stuff that erodes trust over time.

05

GitHub

PR Checks & Comments

GitHub App posts a check status and a sticky PR comment listing every finding, so docs reviews happen in the same place as code reviews.

06

Integration

CI Integration

GitHub Action and CLI for any CI provider. One line to set up. Fails the build on error-severity findings.

03 / Scan & Surface

Issues found. Surfaced where you work.

zivodoc maps every issue in your docs and surfaces them as PR checks, sticky comments, and a live dashboard — your team reviews docs the way they review code.

Runtime error

/guides/quickstart.md

API mismatch

/api/authentication.md

Heading skip

/api/errors.md

Dead link

/guides/webhooks.md

Leaked secret

/api/tokens.md

Syntax error

/guides/pagination.md

zivodoc → GitHub
Surfaced

Check: zivodoc/scan

failure · 4 errors · PR #284

Surfaced

Sticky PR comment

inline file:line context for 23 findings

Surfaced

Live dashboard

history, filters, resolve / ignore

Works With

Every docs framework, every language, every spec.

zivodoc auto-detects your stack. No config needed — just point it at your repo.

Docs Frameworks

Docusaurus
GitBook
Mintlify
ReadMe
Nextra
Starlight
VitePress
Sphinx
MkDocs

Languages

JavaScript
TypeScript
Python
Go
Ruby
cURL
Java
PHP

API Specs

OpenAPI 3.x
Swagger 2.0
GraphQL
REST
gRPC

Content

Markdown
MDX
AsciiDoc
reStructuredText
Stop Losing Users

Your docs are your product's first impression. Make sure they work.

Connect your repo, run the first scan in under 5 minutes. Free tier — no credit card required.

GET STARTED FREESEE ALL FEATURES