Skip to content
boringdocs

Quick Start

Set up your first doc-code validation pipeline in 3 steps.

Step 1: Install & Initialize

npm install -g boringdocs
cd your-project
boringdocs init

Step 2: Write a Validation Rule

Open boringdocs.yaml and add a rule:

rules:
  - name: endpoint-must-have-description
    severity: error
    message: "Every API endpoint must have a description in docs"

Step 3: Run the Check

$ boringdocs check

✓ src/api/users.ts — 3 endpoints validated
✗ src/api/orders.ts — 2 issues found

  orders.ts:42 — POST /orders missing description
  orders.ts:78 — GET /orders/{id} response schema mismatch

2 issues found. Run `boringdocs check --fix` to auto-resolve.

Auto-Fix

boringdocs can auto-generate stub documentation for missing pieces:

boringdocs check --fix

This creates documentation stubs that you can then edit and refine.

Add to CI

Add a step to your CI pipeline:

# .github/workflows/docs.yml
name: Docs Validation
on: [push, pull_request]
jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: npx boringdocs check

What's Next