Skip to content
boringdocs

Installation

Get boringdocs running in under 5 minutes.

Prerequisites

  • Node.js 18+ or Bun 1.0+
  • A git repository with your code and docs

Install the CLI

npm install -g boringdocs
# or
bun install -g boringdocs

Initialize

Run boringdocs init in your project root:

cd your-project
boringdocs init

This creates a boringdocs.yaml config file in your project root.

Configure

Edit boringdocs.yaml to point at your code and docs:

code:
  paths:
    - src/
  languages:
    - typescript
    - javascript

docs:
  paths:
    - docs/
    - README.md
  format: markdown

rules:
  - endpoint-must-have-description
  - response-schema-must-match
  - no-orphaned-docs

Run Validation

boringdocs check

This validates all docs against the current codebase and reports any drift.

Next Steps