Gate and CI

Gates keep incomplete or stale documentation context from reaching coding agents.

Local gate

ak-docs index
ak-docs gate run
ak-docs doctor --text
ak-docs doctor --badge

Typical failures:

Pull request workflow

name: Documentation gate
on: [pull_request]

permissions:
  contents: read

jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: AgentsKit-io/doc-bridge@v1.2.1
        with:
          config-path: doc-bridge.config.json

The composite Action verifies the committed index and configured gates — it does not silently rebuild and hide drift.

If the Action fails:

1. Run ak-docs index locally
2. Review the diff under .doc-bridge/ / llms.txt
3. Commit intentional updates
4. Re-run the PR check

What to commit

Commit generated index artifacts your repo treats as source-of-truth (common: .doc-bridge/index.json, root llms.txt). Keep CI fail-closed when those drift from the docs corpus.

Related

• Marketplace details
• Install and run
• Documentation Standard
• Doctor / CLI