Skip to content
@docattest

docattest

Documentation that CI can fail: Markdown pages carry their own proof. TypeScript, Python, Go and Rust.

docattest: your docs are lying to you

Documentation that CI can fail.

Markdown pages carry their own proof: examples that run, values in the prose that are compared with your code, tables whose rows are tests. When the code changes and a sentence stops being true, the build fails at that page and line.

Try it in the playground · Website · Repository · GitHub Action

npm PyPI crates.io Go MIT licence


A page says what the code does, and a comment says where the truth lives:

A failing call is tried at most `3` times. <!-- fact: RETRY_DEFAULTS.maxAttempts -->

Someone raises the limit to 5 and forgets the docs:

$ docattest check
docs/retries.md
  ✗ L1 fact: expected 3, got 5 from RETRY_DEFAULTS.maxAttempts
FAILED
Language Install
TypeScript, JavaScript npm install --save-dev docattest typescript
Python pip install docattest
Go go install github.com/docattest/docattest/adapters/go/cmd/...@latest
Rust cargo install docattest

Works on the docs you already have, one page at a time. No generated files, no model calls.

Pinned Loading

  1. docattest docattest Public

    Documentation that CI can fail: pages carry their own proof, and code links back to the pages that describe it.

    Rust 1

Repositories

Showing 2 of 2 repositories

People

This organization has no public members. You must be a member to see who’s a part of this organization.

Top languages

Loading…

Most used topics

Loading…