code-review/doc-bridge.config.json at main · AgentsKit-io/code-review · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
{
  "schemaVersion": 1,
  "project": {
    "name": "AgentsKit Code Review"
  },
  "corpus": {
    "agent": {
      "root": "docs/for-agents",
      "index": "docs/for-agents/index.md",
      "include": ["**/*.md"]
    },
    "human": {
      "plugin": "plain-markdown",
      "options": {
        "root": "docs",
        "urlPrefix": null
      }
    }
  },
  "routing": {
    "options": {
      "ownership": {
        "code-review-cli": {
          "path": ".",
          "purpose": "Provider-neutral local and GitHub code review CLI, Action, reporters, and repository documentation.",
          "checks": ["npm run check", "npm pack --dry-run"],
          "agentDoc": "docs/for-agents/code-review-cli.md",
          "humanDoc": "OPERATIONS"
        }
      },
      "intents": [
        {
          "id": "understand-or-run-code-review",
          "title": "Understand or run Code Review",
          "paths": ["README.md", "docs/OPERATIONS.md"]
        }
      ],
      "changes": [
        {
          "id": "change-cli-provider-or-action",
          "title": "Change a CLI provider, flag, reporter, or Action input",
          "startHere": "docs/for-agents/code-review-cli.md"
        }
      ]
    }
  },
  "index": {
    "outFile": ".doc-bridge/index.json",
    "llmsTxt": {
      "enabled": true,
      "outFile": "llms.txt",
      "preamble": "AgentsKit Code Review is a pre-v1 provider-neutral CLI and GitHub Action for low-noise review using seven lenses and adversarial verification. It intentionally has no Fumadocs site or embedded chat.\n\n## Documentation surfaces\n\n- Full corpus: llms-full.txt\n- Public README: https://github.com/AgentsKit-io/code-review-cli#readme\n- Operations: docs/OPERATIONS.md\n- For agents: docs/for-agents/index.md\n- Raw sources: https://raw.githubusercontent.com/AgentsKit-io/code-review-cli/main/\n\n## AgentsKit ecosystem\n\n- AgentsKit: https://www.agentskit.io/docs\n- Registry: https://registry.agentskit.io/docs\n- AgentsKit Chat: https://chat.agentskit.io/docs\n- Playbook: https://playbook.agentskit.io/docs\n- Doc Bridge: https://agentskit-io.github.io/doc-bridge/\n- Code Review: https://github.com/AgentsKit-io/code-review-cli#readme\n- AKOS: https://akos.agentskit.io/docs"
    },
    "capabilities": {
      "enabled": true,
      "outFile": ".doc-bridge/capabilities.json"
    }
  },
  "conformance": {
    "documentationStandardV1": {
      "rawSources": [
        "README.md",
        "docs/OPERATIONS.md",
        "docs/for-agents/code-review-cli.md"
      ],
      "contributionPaths": ["CONTRIBUTING.md"],
      "metadata": [
        {
          "path": "README.md",
          "contains": ["# AgentsKit Code Review", "Deep, low-noise AI code review"]
        }
      ],
      "links": [
        { "url": "https://www.agentskit.io", "paths": ["README.md"] },
        { "url": "https://registry.agentskit.io/docs", "paths": ["README.md"] },
        { "url": "https://chat.agentskit.io/docs", "paths": ["README.md"] },
        { "url": "https://playbook.agentskit.io/docs", "paths": ["README.md"] },
        { "url": "https://agentskit-io.github.io/doc-bridge/", "paths": ["README.md"] },
        { "url": "https://akos.agentskit.io/docs", "paths": ["README.md"] }
      ],
      "ecosystemContract": {
        "manifest": "ecosystem.json",
        "claims": "ecosystem-claims.json",
        "productId": "code-review"
      },
      "quickstarts": [
        {
          "id": "first-review",
          "doc": "README.md",
          "test": "test/cli-smoke.test.mjs",
          "command": "npm run build && node --test test/cli-smoke.test.mjs",
          "testContains": ["a clean local Codex CLI fixture completes an offline stdin review"]
        }
      ],
      "visuals": ["docs/assets/agentskit-mark.svg"],
      "diagrams": [
        { "path": "README.md", "contains": ["```mermaid"] }
      ],
      "exceptions": []
    }
  },
  "gates": {
    "preset": "standard",
    "include": ["documentation-standard-v1"]
  },
  "surfaces": {
    "cli": {
      "bin": "ak-docs",
      "defaultFormat": "text"
    },
    "mcp": {
      "enabled": true,
      "transport": "stdio"
    }
  }
}