@agentskit/doc-bridge 1.2.6 → 1.4.0
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 +19 -0
- package/README.md +32 -6
- package/action.yml +1 -1
- package/dist/cli/program.js +344 -130
- package/dist/cli/program.js.map +1 -1
- package/dist/config/index.d.ts +1 -1
- package/dist/config/index.js +3 -1
- package/dist/config/index.js.map +1 -1
- package/dist/{index-DGI9TBLE.d.ts → index-DAeq_OIi.d.ts} +22 -22
- package/dist/index.d.ts +7 -4
- package/dist/index.js +320 -105
- package/dist/index.js.map +1 -1
- package/docs/MARKETPLACE.md +1 -1
- package/docs/POSITIONING.md +1 -1
- package/docs/examples.md +4 -0
- package/docs/getting-started.md +1 -1
- package/docs/guides/choose-context-layer.md +129 -0
- package/docs/guides/gate-ci.md +1 -1
- package/docs/guides/meta.json +1 -0
- package/docs/landing/index.html +2 -2
- package/docs/playbook/doc-bridge-pattern.md +1 -1
- package/docs/qa/vitepress-starlight-adapters.md +19 -0
- package/docs/recipes/index-pipeline.md +1 -1
- package/docs/spec/config-v1.md +33 -2
- package/examples/nextra-only.config.ts +17 -0
- package/examples/nx-monorepo.config.ts +11 -0
- package/examples/starlight-only.config.ts +17 -0
- package/examples/vitepress-only.config.ts +19 -0
- package/mcpb/manifest.json +1 -1
- package/package.json +15 -4
- package/skills/doc-bridge-handoff/SKILL.md +38 -0
- package/skills/doc-bridge-handoff/fixtures/synthetic-repo/doc-bridge.config.json +23 -0
- package/skills/doc-bridge-handoff/fixtures/synthetic-repo/docs/for-agents/packages/payments.md +5 -0
- package/skills/doc-bridge-handoff/fixtures/synthetic-repo/packages/payments/package.json +4 -0
- package/skills/doc-bridge-handoff/scripts/resolve-handoff.mjs +70 -0
- package/src/config/schema.ts +3 -1
- package/src/index-builder/build-handoffs.ts +2 -0
- package/src/index-builder/build-index.ts +7 -1
- package/src/index-builder/human-adapters/index.ts +6 -0
- package/src/index-builder/human-adapters/nextra.ts +43 -0
- package/src/index-builder/human-adapters/starlight.ts +40 -0
- package/src/index-builder/human-adapters/vitepress.ts +43 -0
- package/src/index-builder/plugins/nx.ts +161 -0
- package/src/index-builder/plugins/pnpm-monorepo.ts +1 -0
- package/src/index-builder/watch-index.ts +11 -2
- package/src/index.ts +1 -0
- package/src/version.ts +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,24 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.4.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 14a9075: Add a portable, fail-closed Doc Bridge handoff skill with a zero-credential resolver and synthetic compatibility fixture for Agent Skills runtimes.
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- 5133bda: Expose the portable Doc Bridge handoff skill as a discoverable Pi package.
|
|
12
|
+
- 14a9075: Add a Cursor plugin manifest, pinned MCP configuration, and handoff skill.
|
|
13
|
+
|
|
14
|
+
## 1.3.0
|
|
15
|
+
|
|
16
|
+
### Minor Changes
|
|
17
|
+
|
|
18
|
+
- 319605e: Add read-only Nx project inference for Doc Bridge ownership, handoffs, and available test and lint checks.
|
|
19
|
+
- e0db193: Add first-party VitePress and Astro Starlight human-documentation adapters.
|
|
20
|
+
- 03c17bc: Add a first-party Nextra human-documentation adapter for deterministic content-directory routes.
|
|
21
|
+
|
|
3
22
|
## 1.2.6
|
|
4
23
|
|
|
5
24
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -106,6 +106,8 @@ npx ak-docs query package example --agent
|
|
|
106
106
|
ak-docs mcp install --cursor # wires MCP into .cursor/mcp.json
|
|
107
107
|
```
|
|
108
108
|
|
|
109
|
+
Using Cline? Follow the deterministic [`llms-install.md`](llms-install.md) setup. It runs the pinned MCP server through `pnpm dlx` without adding Doc Bridge to your repository dependencies.
|
|
110
|
+
|
|
109
111
|
## What ships
|
|
110
112
|
|
|
111
113
|

|
|
@@ -114,15 +116,35 @@ ak-docs mcp install --cursor # wires MCP into .cursor/mcp.json
|
|
|
114
116
|
|---------|------------|--------------------|
|
|
115
117
|
| **CLI** | Inspect ownership, search docs, run gates, ask local questions | `ak-docs query`, `search`, `ask`, `doctor`, `gate` |
|
|
116
118
|
| **MCP server** | Let Cursor, Claude Code, Codex-style agents resolve handoffs before editing | `ak-docs mcp`, `handoff.resolve` |
|
|
117
|
-
| **GitHub Action / CI** | Fail stale indexes and broken human-doc links on PRs | `AgentsKit-io/doc-bridge@v1.
|
|
119
|
+
| **GitHub Action / CI** | Fail stale indexes and broken human-doc links on PRs | `AgentsKit-io/doc-bridge@v1.3.0` |
|
|
118
120
|
| **Documentation conformance** | Check the stable ecosystem standard with auditable evidence | `ak-docs conformance run documentation-standard-v1 --text` |
|
|
119
|
-
| **Doc adapters** | Link human docs to agent docs | `fumadocs`, `docusaurus`, `plain-markdown` |
|
|
120
|
-
| **Monorepo routing** | Discover workspaces and checks | `pnpm-monorepo` |
|
|
121
|
+
| **Doc adapters** | Link human docs to agent docs | `fumadocs`, `docusaurus`, `vitepress`, `starlight`, `nextra`, `plain-markdown` |
|
|
122
|
+
| **Monorepo routing** | Discover workspaces and checks | `pnpm-monorepo`, `nx` |
|
|
121
123
|
| **Memory pipeline** | Turn agent notes into reviewable documentation drafts | `memory ingest`, `classify`, `promote --pr` |
|
|
122
124
|
| **Optional RAG/chat** | Ground chat in the same handoff-first index | `@agentskit/rag`, `@agentskit/ink`, `ak-docs chat` |
|
|
123
125
|
|
|
124
126
|
See [docs/getting-started.md](docs/getting-started.md), [docs/mcp.md](docs/mcp.md), and [docs/examples.md](docs/examples.md).
|
|
125
127
|
|
|
128
|
+
### Cursor plugin
|
|
129
|
+
|
|
130
|
+
This repository also contains a Cursor plugin that pairs the read-only Doc Bridge MCP server with a handoff skill. It resolves `startHere`, `readBeforeEditing`, `editRoots`, and `checks` before Cursor edits a routed repository. The plugin does not request credentials or write project files through MCP.
|
|
131
|
+
|
|
132
|
+
### Portable Agent Skill
|
|
133
|
+
|
|
134
|
+
[`skills/doc-bridge-handoff`](skills/doc-bridge-handoff) packages the same fail-closed routing contract in the open Agent Skills layout for OpenClaw-compatible clients, Hermes Agent, Pi, Cursor, and other runtimes that can execute a local skill script. The skill prefers the read-only MCP tool and falls back to a pinned, zero-credential CLI resolver. It never edits files, runs returned checks, or grants authority outside `editRoots`.
|
|
135
|
+
|
|
136
|
+
Install the published skill from [ClawHub](https://clawhub.ai/emersonbraun/skills/doc-bridge-handoff):
|
|
137
|
+
|
|
138
|
+
```bash
|
|
139
|
+
clawhub install doc-bridge-handoff
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Pi users can install the same source-owned skill through the npm package:
|
|
143
|
+
|
|
144
|
+
```bash
|
|
145
|
+
pi install npm:@agentskit/doc-bridge
|
|
146
|
+
```
|
|
147
|
+
|
|
126
148
|
## Claude Desktop MCP Bundle
|
|
127
149
|
|
|
128
150
|
Doc Bridge can be packaged as a local MCP Bundle for Claude Desktop. The bundle keeps the eight MCP tools read-only and asks the user to select the repository's `doc-bridge.config.json`; that file defines the project boundary Doc Bridge may read.
|
|
@@ -224,7 +246,7 @@ permissions:
|
|
|
224
246
|
|
|
225
247
|
steps:
|
|
226
248
|
- uses: actions/checkout@v4
|
|
227
|
-
- uses: AgentsKit-io/doc-bridge@v1.
|
|
249
|
+
- uses: AgentsKit-io/doc-bridge@v1.3.0
|
|
228
250
|
with:
|
|
229
251
|
config-path: doc-bridge.config.json
|
|
230
252
|
```
|
|
@@ -255,7 +277,7 @@ Gate fails with `Index is stale. Run: ak-docs index` — same check in CI annota
|
|
|
255
277
|
| **CLI** | `query` / `search` / `list` / `ask` / `gate` / `memory` / `bootstrap` |
|
|
256
278
|
| **MCP** | `handoff.resolve`, `doc.search`, `doc.get`, `gate.status`, … |
|
|
257
279
|
| **Gates** | Freshness, human-link validation, optional OKF style |
|
|
258
|
-
| **Adapters** | `pnpm-monorepo`, `fumadocs`, `docusaurus`, `plain-markdown` |
|
|
280
|
+
| **Adapters** | `pnpm-monorepo`, `nx`, `fumadocs`, `docusaurus`, `vitepress`, `starlight`, `nextra`, `plain-markdown` |
|
|
259
281
|
|
|
260
282
|
### Optional AgentsKit peers
|
|
261
283
|
|
|
@@ -290,8 +312,12 @@ Designed for and dogfooded on open AgentsKit surfaces:
|
|
|
290
312
|
|---------|---------|
|
|
291
313
|
| Solo markdown | [`examples/minimal-plain-markdown.config.ts`](examples/minimal-plain-markdown.config.ts) |
|
|
292
314
|
| pnpm monorepo | [`examples/pnpm-monorepo.config.ts`](examples/pnpm-monorepo.config.ts) |
|
|
315
|
+
| Nx monorepo | [`examples/nx-monorepo.config.ts`](examples/nx-monorepo.config.ts) |
|
|
293
316
|
| Demo monorepo | [`examples/demo-monorepo/`](examples/demo-monorepo/) |
|
|
294
317
|
| Fumadocs + chat | [`examples/fumadocs-with-chat.config.ts`](examples/fumadocs-with-chat.config.ts) |
|
|
318
|
+
| VitePress | [`examples/vitepress-only.config.ts`](examples/vitepress-only.config.ts) |
|
|
319
|
+
| Astro Starlight | [`examples/starlight-only.config.ts`](examples/starlight-only.config.ts) |
|
|
320
|
+
| Nextra | [`examples/nextra-only.config.ts`](examples/nextra-only.config.ts) |
|
|
295
321
|
|
|
296
322
|
Contract: [`docs/spec/config-v1.md`](docs/spec/config-v1.md) · CLI: [`docs/spec/cli.md`](docs/spec/cli.md) · MCP: [`docs/mcp.md`](docs/mcp.md) · Skill: [`docs/skills/doc-bridge.md`](docs/skills/doc-bridge.md) · Pattern: [`docs/playbook/doc-bridge-pattern.md`](docs/playbook/doc-bridge-pattern.md) · Recipes: [`docs/recipes/index-pipeline.md`](docs/recipes/index-pipeline.md)
|
|
297
323
|
|
|
@@ -306,7 +332,7 @@ ak-docs memory promote --pr # opens draft PR via gh
|
|
|
306
332
|
|
|
307
333
|
## Status
|
|
308
334
|
|
|
309
|
-
**v1.
|
|
335
|
+
**v1.3.0 stable** — deterministic Documentation Standard v1 conformance, VitePress, Starlight, Nextra, and Nx discovery, verified release provenance, Marketplace Action, doctor + CI + skill, and full Tier A/B/C.
|
|
310
336
|
|
|
311
337
|
```bash
|
|
312
338
|
pnpm install && pnpm build && pnpm test
|