@agentskit/doc-bridge 1.1.1 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +28 -0
- package/CONTRIBUTING.md +1 -0
- package/README.md +39 -8
- package/action.yml +22 -25
- package/dist/cli/program.js +1 -1
- package/dist/cli/program.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/docs/DOGFOOD-ROUND2.md +5 -0
- package/docs/DOGFOOD-ROUND3.md +5 -0
- package/docs/DOGFOOD-V1.md +5 -0
- package/docs/DOGFOOD.md +5 -0
- package/docs/MARKETPLACE-ECOSYSTEM-PLAN.md +16 -0
- package/docs/MARKETPLACE.md +39 -0
- package/docs/POSITIONING.md +5 -0
- package/docs/RELEASE.md +19 -10
- package/docs/agent-corpus/INDEX.md +10 -0
- package/docs/agent-corpus/OVERVIEW.md +9 -0
- package/docs/agent-corpus/chat.md +10 -0
- package/docs/agent-corpus/cli.md +10 -0
- package/docs/agent-corpus/conformance.md +10 -0
- package/docs/agent-corpus/doc-bridge.md +10 -0
- package/docs/agent-corpus/doctor.md +10 -0
- package/docs/agent-corpus/gates.md +10 -0
- package/docs/agent-corpus/mcp.md +10 -0
- package/docs/agent-corpus/memory.md +10 -0
- package/docs/agent-corpus/query.md +10 -0
- package/docs/chat-and-rag.md +34 -0
- package/docs/examples.md +5 -0
- package/docs/for-agents.md +31 -0
- package/docs/getting-started.md +5 -0
- package/docs/index.md +23 -0
- package/docs/landing/index.html +1 -1
- package/docs/mcp.md +5 -0
- package/docs/meta.json +20 -0
- package/docs/ollama-demo.md +6 -1
- package/docs/playbook/doc-bridge-pattern.md +3 -1
- package/docs/query.md +34 -0
- package/docs/recipes/index-pipeline.md +6 -1
- package/docs/schemas/agent-handoff-v1.md +5 -0
- package/docs/schemas/doc-bridge-index-v1.md +5 -0
- package/docs/schemas/memory-candidate-v1.md +5 -0
- package/docs/skills/doc-bridge.md +6 -1
- package/docs/spec/cli.md +5 -0
- package/docs/spec/config-v1.md +5 -0
- package/docs/spec/documentation-standard-v1.md +5 -0
- package/docs/spec/playbook-feedback.md +5 -0
- package/docs/spec/registry-agents.md +5 -0
- package/ecosystem-claims.json +2 -2
- package/ecosystem-upstream.json +2 -2
- package/ecosystem.json +21 -17
- package/examples/verify-handoff.mjs +5 -0
- package/package.json +37 -5
- package/src/version.ts +1 -1
package/docs/DOGFOOD-ROUND2.md
CHANGED
package/docs/DOGFOOD-ROUND3.md
CHANGED
package/docs/DOGFOOD-V1.md
CHANGED
package/docs/DOGFOOD.md
CHANGED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Ecosystem and Marketplace acceptance plan
|
|
3
|
+
description: Internal acceptance criteria for the Doc Bridge ecosystem and Marketplace slice.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Doc Bridge ecosystem and Marketplace acceptance plan
|
|
7
|
+
|
|
8
|
+
This slice is complete only when all conditions below are evidenced locally. Publication remains an owner-only follow-up.
|
|
9
|
+
|
|
10
|
+
- Composite Action validates committed freshness, accepts shell inputs only through quoted environment variables, pins its runtime package, and pins third-party Actions by SHA.
|
|
11
|
+
- Marketplace metadata, consumer example, release-owner checklist, and automated contract checks agree on the same version.
|
|
12
|
+
- The public portal exposes seven ecosystem products, six Doc Bridge peers, and contextual routes for Chat, Code Review, and AKOS.
|
|
13
|
+
- `/for-agents`, `llms.txt`, `llms-full.txt`, raw Markdown, and deterministic knowledge are public and cross-linked.
|
|
14
|
+
- Human docs remain concise and navigable; source-heavy detail stays in raw/full machine surfaces.
|
|
15
|
+
- Landing and documentation pages have no horizontal overflow at 375, 768, 1280, or 1440 pixels.
|
|
16
|
+
- `ak-docs gate run`, documentation conformance, and `ak-docs doctor` finish at 100/A.
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: GitHub Marketplace
|
|
3
|
+
description: Add the Doc Bridge freshness gate to pull requests with a reproducible composite Action.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# GitHub Marketplace
|
|
7
|
+
|
|
8
|
+
Doc Bridge ships one root composite Action: `doc-bridge-gate`. It verifies the committed index and configured documentation gates without rebuilding artifacts first.
|
|
9
|
+
|
|
10
|
+
## Use it in a repository
|
|
11
|
+
|
|
12
|
+
```yaml
|
|
13
|
+
name: Documentation gate
|
|
14
|
+
on: [pull_request]
|
|
15
|
+
|
|
16
|
+
permissions:
|
|
17
|
+
contents: read
|
|
18
|
+
|
|
19
|
+
jobs:
|
|
20
|
+
docs:
|
|
21
|
+
runs-on: ubuntu-latest
|
|
22
|
+
steps:
|
|
23
|
+
- uses: actions/checkout@v4
|
|
24
|
+
- uses: AgentsKit-io/doc-bridge@v1.2.1
|
|
25
|
+
with:
|
|
26
|
+
config-path: doc-bridge.config.json
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
If the index is stale, run `ak-docs index`, review the generated diff, and commit it. The Action's default package version matches its immutable release tag.
|
|
30
|
+
|
|
31
|
+
## Release-owner checklist
|
|
32
|
+
|
|
33
|
+
1. Run `pnpm check:marketplace`, `pnpm test:marketplace`, and the repository release matrix.
|
|
34
|
+
2. Confirm the public repository contains exactly one root `action.yml` and its name is available.
|
|
35
|
+
3. Push the immutable semver tag. The release workflow publishes npm, uploads the artifact, and leaves a GitHub Release draft ready for review.
|
|
36
|
+
4. Open that draft, select **Publish this Action to the GitHub Marketplace**, choose categories, and accept the GitHub Marketplace Developer Agreement if prompted.
|
|
37
|
+
5. Publish the release, then verify the listing and execute the exact consumer workflow above in a clean fixture repository.
|
|
38
|
+
|
|
39
|
+
Marketplace publication is a deliberate owner action; the workflow never moves tags and does not publish the GitHub Release before the Marketplace fields are complete.
|
package/docs/POSITIONING.md
CHANGED
package/docs/RELEASE.md
CHANGED
|
@@ -1,3 +1,8 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Release checklist
|
|
3
|
+
description: Reproducible package, documentation, and registry checks for a Doc Bridge release.
|
|
4
|
+
---
|
|
5
|
+
|
|
1
6
|
# Release checklist — `@agentskit/doc-bridge`
|
|
2
7
|
|
|
3
8
|
## Pre-flight (local)
|
|
@@ -27,37 +32,41 @@ pnpm changeset # if new entry needed
|
|
|
27
32
|
pnpm version-packages # bumps package.json + CHANGELOG from .changeset/*
|
|
28
33
|
```
|
|
29
34
|
|
|
30
|
-
Current track: **`1.
|
|
35
|
+
Current track: **`1.2.1` stable** (alpha series ended at `0.1.0-alpha.5`).
|
|
31
36
|
|
|
32
37
|
## Publish (npm + GitHub)
|
|
33
38
|
|
|
34
|
-
Stable
|
|
39
|
+
Stable packages are published only by `.github/workflows/release.yml` from an immutable semver tag. The workflow re-runs the complete security, test, coverage, packaged-smoke, dogfood, Marketplace-contract, and conformance matrix, publishes npm with provenance, verifies the registry result, uploads the tarball to a GitHub Release draft, and leaves final publication to the owner so the Marketplace fields can be completed first.
|
|
35
40
|
|
|
36
41
|
```bash
|
|
37
|
-
git tag v1.
|
|
38
|
-
git push origin v1.
|
|
42
|
+
git tag v1.2.1
|
|
43
|
+
git push origin v1.2.1
|
|
39
44
|
```
|
|
40
45
|
|
|
41
46
|
For recovery of an existing immutable tag, use the guarded manual dispatch. Never move or recreate a release tag.
|
|
42
47
|
|
|
43
48
|
```bash
|
|
44
|
-
gh workflow run release.yml --ref master -f tag=v1.
|
|
49
|
+
gh workflow run release.yml --ref master -f tag=v1.2.1
|
|
45
50
|
```
|
|
46
51
|
|
|
47
52
|
Confirm:
|
|
48
53
|
|
|
49
54
|
```bash
|
|
50
|
-
npm view @agentskit/doc-bridge@1.
|
|
51
|
-
npx ak-docs@1.
|
|
52
|
-
gh release view v1.
|
|
55
|
+
npm view @agentskit/doc-bridge@1.2.1 version dist.integrity
|
|
56
|
+
npx ak-docs@1.2.1 --version
|
|
57
|
+
gh release view v1.2.1 --json isDraft
|
|
53
58
|
```
|
|
54
59
|
|
|
55
|
-
GitHub Pages must remain configured for GitHub Actions; `.github/workflows/pages.yml` deploys the
|
|
60
|
+
GitHub Pages must remain configured for GitHub Actions; `.github/workflows/pages.yml` builds and deploys the Fumadocs portal from `apps/docs`.
|
|
61
|
+
|
|
62
|
+
## Publish the GitHub Action to Marketplace
|
|
63
|
+
|
|
64
|
+
Run `pnpm check:marketplace && pnpm test:marketplace`, then follow [the Marketplace guide](./MARKETPLACE.md). In the generated release draft, select the Marketplace option and categories before publishing the GitHub Release. npm success alone does not publish the listing.
|
|
56
65
|
|
|
57
66
|
## Post-publish smoke (fresh machine)
|
|
58
67
|
|
|
59
68
|
```bash
|
|
60
|
-
npm i -D @agentskit/doc-bridge@1.
|
|
69
|
+
npm i -D @agentskit/doc-bridge@1.2.1
|
|
61
70
|
npx ak-docs init
|
|
62
71
|
npx ak-docs index
|
|
63
72
|
npx ak-docs query package example --agent
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: package
|
|
3
|
+
package: doc-bridge-index
|
|
4
|
+
editRoot: src/index-builder
|
|
5
|
+
humanDoc: /docs/recipes/index-pipeline
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Index builder
|
|
9
|
+
|
|
10
|
+
Owns corpus scanning, handoffs, hashes, `llms.txt`, and watch mode. Generated output must remain deterministic.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: index
|
|
3
|
+
purpose: Route coding agents to Doc Bridge ownership sidecars.
|
|
4
|
+
owner: maintainers
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Doc Bridge agent corpus
|
|
8
|
+
|
|
9
|
+
Resolve the requested ownership ID with `ak-docs query ownership <id> --agent`. Read the returned sidecar and its linked human guide before editing.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: package
|
|
3
|
+
package: doc-bridge-chat
|
|
4
|
+
editRoot: src/intelligence
|
|
5
|
+
humanDoc: /docs/chat-and-rag
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Chat and RAG
|
|
9
|
+
|
|
10
|
+
Owns optional AgentsKit retrieval and chat after deterministic lookup. Conversational UI belongs to AgentsKit Chat; enterprise orchestration belongs to AKOS.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: package
|
|
3
|
+
package: doc-bridge-conformance
|
|
4
|
+
editRoot: src/conformance
|
|
5
|
+
humanDoc: /docs/spec/documentation-standard-v1
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Conformance
|
|
9
|
+
|
|
10
|
+
Owns versioned documentation-standard rules and evidence. Do not turn missing evidence into a passing score.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: package
|
|
3
|
+
package: doc-bridge-memory
|
|
4
|
+
editRoot: src/memory
|
|
5
|
+
humanDoc: /docs/schemas/memory-candidate-v1
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Memory
|
|
9
|
+
|
|
10
|
+
Owns reviewable learning ingestion, classification, and promotion. Durable knowledge becomes a documented change, never silent state.
|
package/docs/chat-and-rag.md
CHANGED
|
@@ -1,3 +1,8 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Chat and RAG
|
|
3
|
+
description: Add optional AgentsKit retrieval and chat after deterministic documentation resolution.
|
|
4
|
+
---
|
|
5
|
+
|
|
1
6
|
# Chat and RAG (Layer 1)
|
|
2
7
|
|
|
3
8
|
Layer 0 (index, handoff, MCP, gates, memory pipeline) never requires an LLM.
|
|
@@ -12,6 +17,35 @@ Layer 1 is **opt-in** and dogfoods public AgentsKit packages:
|
|
|
12
17
|
| `@agentskit/ink` | Terminal chat UI (`ak-docs chat`) |
|
|
13
18
|
| `react` | Required by Ink |
|
|
14
19
|
|
|
20
|
+
## Public docs chat: deterministic before backend
|
|
21
|
+
|
|
22
|
+
The documentation portal uses `@agentskit/chat` (root), `@agentskit/chat/react`,
|
|
23
|
+
and `@agentskit/chat/protocol` directly — the consolidated AgentsKit Chat 0.3.x
|
|
24
|
+
surface. It does not recreate chat lifecycle or session state.
|
|
25
|
+
|
|
26
|
+
At build time, `scripts/build-docs-artifacts.mjs` reads the fresh
|
|
27
|
+
`.doc-bridge/index.json` and canonical `docs/**` corpus, then writes:
|
|
28
|
+
|
|
29
|
+
- `deterministic/knowledge.json` — exact commands, documents, and real ownership handoffs;
|
|
30
|
+
- `deterministic/site-config.json` — trusted artifact hash plus fallback policy;
|
|
31
|
+
- `llms.txt`, `llms-full.txt`, and `raw/**` — model-friendly public sources.
|
|
32
|
+
|
|
33
|
+
The browser verifies the SHA-256 content hash before using the artifact. A
|
|
34
|
+
known exact question answers locally with provenance. Multiple exact matches
|
|
35
|
+
return local choices. Only a genuine miss reaches the configured backend, and
|
|
36
|
+
the UI reports a backend answer only after a successful completed stream.
|
|
37
|
+
|
|
38
|
+
```mermaid
|
|
39
|
+
flowchart LR
|
|
40
|
+
Q[Question] --> A{Verified exact match?}
|
|
41
|
+
A -->|one| L[Local answer + citation]
|
|
42
|
+
A -->|many| C[Local choices]
|
|
43
|
+
A -->|none| B[AgentsKit backend]
|
|
44
|
+
B --> S{Completed stream?}
|
|
45
|
+
S -->|yes| R[Backend answer + provenance]
|
|
46
|
+
S -->|no| E[Retryable error]
|
|
47
|
+
```
|
|
48
|
+
|
|
15
49
|
## Trust model
|
|
16
50
|
|
|
17
51
|
1. **`handoffFirst`** (default): if the question mentions a known package id, attach deterministic AgentHandoff context before the model answers.
|
package/docs/examples.md
CHANGED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: For agents
|
|
3
|
+
description: Resolve ownership, read compact context, and run the repository's own checks before editing.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# For agents
|
|
7
|
+
|
|
8
|
+
Use Doc Bridge before changing a module. It returns versioned, runtime-validated data instead of asking a model to infer ownership from the entire repository.
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
ak-docs query ownership <id> --agent
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
The response supplies four things: `startHere`, `readBeforeEditing`, `editRoots`, and `checks`.
|
|
15
|
+
|
|
16
|
+
```mermaid
|
|
17
|
+
flowchart LR
|
|
18
|
+
Q["Resolve ownership"] --> R["Read startHere"]
|
|
19
|
+
R --> E["Edit only editRoots"]
|
|
20
|
+
E --> T["Run checks"]
|
|
21
|
+
T --> P["Promote durable learning"]
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Machine entry points
|
|
25
|
+
|
|
26
|
+
- [`llms.txt`](https://agentskit-io.github.io/doc-bridge/llms.txt) — concise discovery and canonical routes
|
|
27
|
+
- [`llms-full.txt`](https://agentskit-io.github.io/doc-bridge/llms-full.txt) — complete source corpus
|
|
28
|
+
- [`deterministic/knowledge.json`](https://agentskit-io.github.io/doc-bridge/deterministic/knowledge.json) — local chat/discovery artifact
|
|
29
|
+
- [`raw/for-agents.md`](https://agentskit-io.github.io/doc-bridge/raw/for-agents.md) — this guide as raw Markdown
|
|
30
|
+
|
|
31
|
+
If the task is conversational UI, continue with [AgentsKit Chat](https://chat.agentskit.io). For verification before merge, use [AgentsKit Code Review](https://github.com/AgentsKit-io/code-review-cli). For enterprise orchestration, governance, and audit, continue with [AKOS](https://akos.agentskit.io).
|
package/docs/getting-started.md
CHANGED
package/docs/index.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Documentation
|
|
3
|
+
description: Choose the shortest Doc Bridge path for humans, agents, or pull-request enforcement.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Documentation
|
|
7
|
+
|
|
8
|
+
Doc Bridge keeps one repository useful to both people and coding agents. Start with the outcome you need:
|
|
9
|
+
|
|
10
|
+
- **Try it locally:** [Getting started](./getting-started.md)
|
|
11
|
+
- **Route an agent:** [For agents](./for-agents.md)
|
|
12
|
+
- **Block stale context in PRs:** [GitHub Marketplace](./MARKETPLACE.md)
|
|
13
|
+
- **Connect an MCP client:** [MCP](./mcp.md)
|
|
14
|
+
|
|
15
|
+
```mermaid
|
|
16
|
+
flowchart LR
|
|
17
|
+
D["Repository docs"] --> I["Deterministic index"]
|
|
18
|
+
I --> H["Human guide"]
|
|
19
|
+
I --> A["Agent handoff"]
|
|
20
|
+
I --> G["Pull-request gate"]
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Long-form contracts remain available under **Specification** and as raw Markdown, without making the primary path read like a reference manual.
|
package/docs/landing/index.html
CHANGED
|
@@ -337,7 +337,7 @@
|
|
|
337
337
|
<div class="terminal-bar"><span class="dot dot-r"></span><span class="dot dot-y"></span><span class="dot dot-g"></span></div>
|
|
338
338
|
<div class="terminal-body">
|
|
339
339
|
<div class="t-dim"># .github/workflows/pr.yml</div>
|
|
340
|
-
<div>- uses: <span class="t-hi">AgentsKit-io/doc-bridge@v1.
|
|
340
|
+
<div>- uses: <span class="t-hi">AgentsKit-io/doc-bridge@v1.2.1</span></div>
|
|
341
341
|
<div> with:</div>
|
|
342
342
|
<div> config-path: doc-bridge.config.json</div>
|
|
343
343
|
</div>
|
package/docs/mcp.md
CHANGED
package/docs/meta.json
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
{
|
|
2
|
+
"title": "Doc Bridge",
|
|
3
|
+
"pages": [
|
|
4
|
+
"index",
|
|
5
|
+
"getting-started",
|
|
6
|
+
"for-agents",
|
|
7
|
+
"MARKETPLACE",
|
|
8
|
+
"POSITIONING",
|
|
9
|
+
"mcp",
|
|
10
|
+
"query",
|
|
11
|
+
"examples",
|
|
12
|
+
"chat-and-rag",
|
|
13
|
+
"ollama-demo",
|
|
14
|
+
"playbook",
|
|
15
|
+
"recipes",
|
|
16
|
+
"schemas",
|
|
17
|
+
"skills",
|
|
18
|
+
"spec"
|
|
19
|
+
]
|
|
20
|
+
}
|
package/docs/ollama-demo.md
CHANGED
|
@@ -1,3 +1,8 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Ollama chat demo
|
|
3
|
+
description: Run the optional local chat layer with Ollama after deterministic routing.
|
|
4
|
+
---
|
|
5
|
+
|
|
1
6
|
# Ollama chat demo (Layer 1)
|
|
2
7
|
|
|
3
8
|
Zero-cloud path for grounded `ak-docs chat` and `ak-docs ask --chat`.
|
|
@@ -61,4 +66,4 @@ Skips gracefully if Ollama is down or peers are missing (safe for CI as optional
|
|
|
61
66
|
| `Intelligence provider request failed` | `ollama serve` not running |
|
|
62
67
|
| `Optional peer "@agentskit/rag" is not installed` | Install Layer 1 peers (see above) |
|
|
63
68
|
| Empty chat response | Pull models: `ollama pull llama3.2` |
|
|
64
|
-
| Slow first `rag ingest` | Normal — embeds entire corpus locally |
|
|
69
|
+
| Slow first `rag ingest` | Normal — embeds entire corpus locally |
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
type: pattern
|
|
3
3
|
id: doc-bridge-pattern
|
|
4
|
+
title: Doc Bridge pattern
|
|
5
|
+
description: A reusable pattern for making documentation useful to humans and agents.
|
|
4
6
|
purpose: Route coding agents to the correct package, checks, and human docs in any monorepo.
|
|
5
7
|
owner: AgentsKit
|
|
6
8
|
license: CC-BY-4.0
|
|
@@ -75,7 +77,7 @@ Agents call `handoff.resolve` before editing `packages/*`:
|
|
|
75
77
|
## CI gate
|
|
76
78
|
|
|
77
79
|
```yaml
|
|
78
|
-
- uses: AgentsKit-io/doc-bridge@v1.
|
|
80
|
+
- uses: AgentsKit-io/doc-bridge@v1.2.1
|
|
79
81
|
```
|
|
80
82
|
|
|
81
83
|
Or: `ak-docs index && ak-docs gate run` — stale index fails the PR.
|
package/docs/query.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Deterministic query engine
|
|
3
|
+
description: Ownership and documentation lookup rules for contributors changing Doc Bridge query behavior.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Deterministic query engine
|
|
7
|
+
|
|
8
|
+
The query layer reads the generated `.doc-bridge/index.json`; it does not scan
|
|
9
|
+
the repository again and does not call a model. Keep exact ownership resolution,
|
|
10
|
+
ranked document search, and handoff output deterministic.
|
|
11
|
+
|
|
12
|
+
## Ownership
|
|
13
|
+
|
|
14
|
+
- Source: `src/query/**`
|
|
15
|
+
- Index contract: `src/schemas/doc-bridge-index.ts`
|
|
16
|
+
- Handoff contract: `src/schemas/agent-handoff.ts`
|
|
17
|
+
- CLI consumers: `src/cli/program.ts`
|
|
18
|
+
- MCP consumers: `src/mcp/server.ts`
|
|
19
|
+
|
|
20
|
+
## Before editing
|
|
21
|
+
|
|
22
|
+
Read [DocBridgeIndex v1](./schemas/doc-bridge-index-v1.md), [AgentHandoff v1](./schemas/agent-handoff-v1.md), and the [CLI reference](./spec/cli.md).
|
|
23
|
+
|
|
24
|
+
## Checks
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
pnpm test
|
|
28
|
+
pnpm typecheck
|
|
29
|
+
node bin/ak-docs.js index
|
|
30
|
+
node bin/ak-docs.js query package doc-bridge-query --agent
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Preserve stable JSON fields and text output. A breaking contract change requires
|
|
34
|
+
a schema version rather than an implicit reinterpretation of v1.
|
|
@@ -1,3 +1,8 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Index pipeline recipes
|
|
3
|
+
description: Compose indexing, querying, gating, and CI into repeatable documentation workflows.
|
|
4
|
+
---
|
|
5
|
+
|
|
1
6
|
# Index pipeline recipes
|
|
2
7
|
|
|
3
8
|
Keep `.doc-bridge/index.json` fresh during development and in CI.
|
|
@@ -66,7 +71,7 @@ Root `package.json`:
|
|
|
66
71
|
## CI (GitHub Action)
|
|
67
72
|
|
|
68
73
|
```yaml
|
|
69
|
-
- uses: AgentsKit-io/doc-bridge@v1.
|
|
74
|
+
- uses: AgentsKit-io/doc-bridge@v1.2.1
|
|
70
75
|
```
|
|
71
76
|
|
|
72
77
|
Or manual:
|
|
@@ -1,3 +1,8 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Agent routing skill
|
|
3
|
+
description: Give coding agents a deterministic recipe for finding ownership and checks.
|
|
4
|
+
---
|
|
5
|
+
|
|
1
6
|
# Doc Bridge — agent routing skill
|
|
2
7
|
|
|
3
8
|
Use this skill in Cursor, Claude Code, or Codex so agents resolve ownership **before** editing packages.
|
|
@@ -61,4 +66,4 @@ Before editing any file under packages/ or apps/:
|
|
|
61
66
|
```bash
|
|
62
67
|
ak-docs ask "auth is broken in staging"
|
|
63
68
|
ak-docs doctor --text
|
|
64
|
-
```
|
|
69
|
+
```
|
package/docs/spec/cli.md
CHANGED
|
@@ -1,3 +1,8 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ak-docs CLI
|
|
3
|
+
description: Complete command reference for indexing, querying, gates, doctor, memory, and MCP.
|
|
4
|
+
---
|
|
5
|
+
|
|
1
6
|
# ak-docs CLI
|
|
2
7
|
|
|
3
8
|
Command-line interface for **`@agentskit/doc-bridge`**. The npm package is scoped; the **only published binary** is `ak-docs`.
|
package/docs/spec/config-v1.md
CHANGED
|
@@ -1,3 +1,8 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Configuration contract v1
|
|
3
|
+
description: Configure documentation corpora, ownership routing, conformance, and gates.
|
|
4
|
+
---
|
|
5
|
+
|
|
1
6
|
# doc-bridge config contract v1
|
|
2
7
|
|
|
3
8
|
`doc-bridge.config.ts` (or `.js`, `.mjs`, `.json`, or `package.json` → `docBridge`) is the alpha integration point for any project. Layer 0 fields are sufficient to run `index`, `query`, and MCP without an LLM.
|
|
@@ -1,3 +1,8 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Playbook feedback promotion
|
|
3
|
+
description: Promote durable implementation lessons into reviewed AgentsKit Playbook contributions.
|
|
4
|
+
---
|
|
5
|
+
|
|
1
6
|
# Playbook Feedback Promotion
|
|
2
7
|
|
|
3
8
|
doc-bridge can feed durable documentation learnings back into public patterns, but promotion must be explicit and reviewable.
|
|
@@ -1,3 +1,8 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Registry agent topology
|
|
3
|
+
description: Connect registry agent definitions to Doc Bridge ownership and documentation handoffs.
|
|
4
|
+
---
|
|
5
|
+
|
|
1
6
|
# Registry Agent Topology
|
|
2
7
|
|
|
3
8
|
doc-bridge exposes deterministic tools; Registry agents can compose them into maintenance flows.
|
package/ecosystem-claims.json
CHANGED