Introduction

boringdocs is the validation layer between your code and your docs. It continuously checks that your documentation matches your codebase — catching drift before your users do.

What boringdocs Does

Documentation drifts from code the moment it's written. Within a quarter, 40% of API docs contain inaccuracies. boringdocs solves this by treating documentation like code: continuous validation, automated checks, and a tight feedback loop.

How It Works

1. Connect — Point boringdocs at your codebase and your docs. No migration needed.
2. Validate — boringdocs parses both, building a map of what your code does and what your docs say.
3. Monitor — On every commit, boringdocs checks for drift. When something changes in code but not in docs, you know.

Key Concepts

Doc-Code Sync

The core mechanism. boringdocs maintains a live mapping between code constructs (endpoints, functions, types) and their documentation.

Drift Detection

When code changes but docs don't, boringdocs flags it. Not as an error — as a signal that something needs attention.

Validation Rules

Configurable rules that define what "accurate" means for your project. From "every endpoint must have a description" to "response schemas must match exactly."

Supported Formats

Format	Status
Markdown	Supported
OpenAPI / Swagger	Supported
JSDoc / TSDoc	Supported
Python docstrings	Planned
Rust doc comments	Planned