Set up DocsCI in 5 minutes

Create an account

Sign up with your work email. No credit card required for the free tier. A personal org is created automatically.

Create a project

Go to Projects and click + New Project. The wizard will ask for:

• GitHub repo URL — validated format: https://github.com/owner/repo
• Docs path — folder containing your Markdown files (default: docs)
• OpenAPI spec — optional: path in repo or remote URL for drift detection
• Network allowlist — domains your code examples may call

💡 Tip: Click "Use stripe/stripe-node (sample)" to start with a pre-filled public repo.

Trigger your first run

Click ▶ Run CI on your project page. DocsCI will: execute all code snippets in sandboxes, run accessibility checks, lint copy, and detect API drift — in parallel. Typical duration: 15–60 seconds.

Review findings

Each finding has a severity (error, warning, info), kind (snippet failure, API drift, accessibility, copy), and an AI-generated fix with a patch diff you can download.

Add the GitHub Action

Copy the workflow from CI Templates to auto-run DocsCI on every push:

# .github/workflows/docsci.yml
name: DocsCI
on: [push, pull_request]
jobs:
  docs-ci:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: |
          curl -X POST https://snippetci.com/api/runs/queue \
            -H "Authorization: Bearer ${{ secrets.DOCSCI_TOKEN }}" \
            -H "Content-Type: application/json" \
            -d '{"mode":"repo","repo_id":"${{ vars.DOCSCI_PROJECT_ID }}"}'