Keep your documentation in sync with your codebase automatically. Run drift detection, integration tests, and custom rule checks in your CI pipeline.
Powerful CI tools to ensure your documentation stays accurate and up to date
Run drift detection in your CI pipeline to catch documentation that needs attention before it reaches production.
Auto-fix Line Numbers
Automatically update line numbers when code shifts above or below snippets
Flag Content Changes
Alert when code inside a snippet changes and needs review
Git-Aware Tracking
Uses git history to intelligently track how code has moved
Turn your HTTP Request blocks into executable integration tests. Verify your APIs match your documentation.
Execute Request Blocks
Run documented API requests against your actual endpoints
Response Validation
Verify responses match expected status codes and schemas
Test Sequences
Chain requests together to test complete workflows
Define custom rules to ensure consistency and quality across all your documentation.
File Name Conventions
Enforce naming patterns for documentation files and folders
Required Sections
Ensure documents include required content sections
Custom Validators
Write your own validation rules for project-specific needs
Here's what running Doclific in your CI pipeline will look like
name: Documentation Check
on: [pull_request]
jobs:
docs-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Check snippet drift
run: doclific-ci check --fix
- name: Run integration tests
run: doclific-ci test --base-url ${{ secrets.API_URL }}
- name: Validate rules
run: doclific-ci lint
- name: Commit auto-fixes
run: |
git diff --quiet || (
git add -A &&
git commit -m "docs: auto-fix snippet line numbers"
)Sign up to be the first to know when CI integration launches