@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/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,33 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.2.1
|
|
4
|
+
|
|
5
|
+
### Fixes
|
|
6
|
+
|
|
7
|
+
- Restore the stable release audit with pnpm's bulk advisory client and pin patched transitive versions of PostCSS, tmp, and uuid.
|
|
8
|
+
|
|
9
|
+
## 1.2.0
|
|
10
|
+
|
|
11
|
+
### Minor Changes
|
|
12
|
+
|
|
13
|
+
- d4260b9: Add the production documentation portal, deterministic AgentsKit Chat knowledge surface, generated LLM and raw Markdown artifacts, and README Standard v1 quality gates.
|
|
14
|
+
|
|
15
|
+
## Unreleased
|
|
16
|
+
|
|
17
|
+
### Features
|
|
18
|
+
|
|
19
|
+
- Migrate the documentation portal dogfood from AgentsKit Chat 0.2 packages (`@agentskit/chat-protocol`, `@agentskit/chat-react`) to the consolidated 0.3.x surface (`@agentskit/chat/protocol`, `@agentskit/chat/react`) while keeping `@agentskit/chat` as the root package.
|
|
20
|
+
- Replace the legacy Pages landing with a statically exported Fumadocs portal backed directly by the canonical `docs/**` corpus.
|
|
21
|
+
- Generate `llms.txt`, `llms-full.txt`, raw Markdown, and a hash-verified deterministic AgentsKit Chat artifact from the repository's own Doc Bridge index.
|
|
22
|
+
- Add dynamic AgentsKit Chat dogfood with local exact answers, ambiguity choices, session-aware backend fallback, and explicit provenance.
|
|
23
|
+
- Adopt README Standard v1 for repository, package, and public-app profiles with synchronized executable examples and freshness evidence.
|
|
24
|
+
|
|
25
|
+
### Quality
|
|
26
|
+
|
|
27
|
+
- Add `pnpm check:no-legacy-chat-imports` to reject any reintroduction of `@agentskit/chat-protocol` or `@agentskit/chat-react`.
|
|
28
|
+
- Add desktop/mobile Playwright coverage for the landing, Fumadocs, local chat, ambiguity, and completed backend stream.
|
|
29
|
+
- Expand self-ownership handoffs across CLI, indexing, query, MCP, quality, memory, and intelligence modules.
|
|
30
|
+
|
|
3
31
|
## 1.1.1
|
|
4
32
|
|
|
5
33
|
### Fixes
|
package/CONTRIBUTING.md
CHANGED
|
@@ -18,6 +18,7 @@ pnpm build
|
|
|
18
18
|
- Prefer existing helpers and Node APIs before adding dependencies.
|
|
19
19
|
- Add or update the smallest test that would fail if the behavior regresses.
|
|
20
20
|
- Public contract changes must update the relevant docs under `docs/spec/` or `docs/schemas/`.
|
|
21
|
+
- Dogfood AgentsKit Chat 0.3.x only: `@agentskit/chat`, `@agentskit/chat/protocol`, and `@agentskit/chat/react`. Never reintroduce `@agentskit/chat-protocol` or `@agentskit/chat-react` (`pnpm check:no-legacy-chat-imports`).
|
|
21
22
|
|
|
22
23
|
## Pull request checklist
|
|
23
24
|
|
package/README.md
CHANGED
|
@@ -9,6 +9,10 @@
|
|
|
9
9
|
|
|
10
10
|
**npm:** [`@agentskit/doc-bridge`](https://www.npmjs.com/package/@agentskit/doc-bridge) · **CLI:** `ak-docs` · **Landing:** [agentskit-io.github.io/doc-bridge](https://agentskit-io.github.io/doc-bridge/)
|
|
11
11
|
|
|
12
|
+
**Topics:** `ai-agents` · `documentation` · `developer-experience` · `mcp` · `llms-txt` · `typescript`
|
|
13
|
+
|
|
14
|
+
**Compatibility:** node >=22 · TypeScript 5.8+ · pnpm, npm, or yarn consumers
|
|
15
|
+
|
|
12
16
|
**Turn your docs into executable handoffs for coding agents.**
|
|
13
17
|
|
|
14
18
|
doc-bridge reads your repo docs, ownership map, and human documentation site, then gives every agent the same answer:
|
|
@@ -18,7 +22,7 @@ doc-bridge reads your repo docs, ownership map, and human documentation site, th
|
|
|
18
22
|
- which checks prove the change
|
|
19
23
|
- which human docs explain the feature
|
|
20
24
|
|
|
21
|
-
It is not a wiki
|
|
25
|
+
It is not a wiki or hosted RAG. The core works **without any LLM or API key**; the documentation portal dogfoods AgentsKit Chat as an optional surface over that deterministic layer.
|
|
22
26
|
|
|
23
27
|

|
|
24
28
|
|
|
@@ -74,6 +78,24 @@ Monorepo fixture with auth + billing:
|
|
|
74
78
|
npx ak-docs demo --fixture monorepo --text
|
|
75
79
|
```
|
|
76
80
|
|
|
81
|
+
### Verify the real handoff path
|
|
82
|
+
|
|
83
|
+
This checked example runs the bundled demo through the public CLI. The README gate compares this block byte-for-byte with the executable fixture and runs it on every PR.
|
|
84
|
+
|
|
85
|
+
<!-- readme-command:verify-handoff -->
|
|
86
|
+
<!-- readme-example:verify-handoff -->
|
|
87
|
+
```js
|
|
88
|
+
import { execFileSync } from 'node:child_process'
|
|
89
|
+
|
|
90
|
+
execFileSync(process.execPath, ['bin/ak-docs.js', 'demo', '--text'], {
|
|
91
|
+
stdio: 'inherit',
|
|
92
|
+
})
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
node examples/verify-handoff.mjs
|
|
97
|
+
```
|
|
98
|
+
|
|
77
99
|
Full setup in your repo:
|
|
78
100
|
|
|
79
101
|
```bash
|
|
@@ -91,7 +113,7 @@ ak-docs mcp install --cursor # wires MCP into .cursor/mcp.json
|
|
|
91
113
|
|---------|------------|--------------------|
|
|
92
114
|
| **CLI** | Inspect ownership, search docs, run gates, ask local questions | `ak-docs query`, `search`, `ask`, `doctor`, `gate` |
|
|
93
115
|
| **MCP server** | Let Cursor, Claude Code, Codex-style agents resolve handoffs before editing | `ak-docs mcp`, `handoff.resolve` |
|
|
94
|
-
| **GitHub Action / CI** | Fail stale indexes and broken human-doc links on PRs | `AgentsKit-io/doc-bridge@v1.
|
|
116
|
+
| **GitHub Action / CI** | Fail stale indexes and broken human-doc links on PRs | `AgentsKit-io/doc-bridge@v1.2.1` |
|
|
95
117
|
| **Documentation conformance** | Check the stable ecosystem standard with auditable evidence | `ak-docs conformance run documentation-standard-v1 --text` |
|
|
96
118
|
| **Doc adapters** | Link human docs to agent docs | `fumadocs`, `docusaurus`, `plain-markdown` |
|
|
97
119
|
| **Monorepo routing** | Discover workspaces and checks | `pnpm-monorepo` |
|
|
@@ -181,11 +203,18 @@ Next actions
|
|
|
181
203
|
Reuse the bundled GitHub Action on every PR:
|
|
182
204
|
|
|
183
205
|
```yaml
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
206
|
+
permissions:
|
|
207
|
+
contents: read
|
|
208
|
+
|
|
209
|
+
steps:
|
|
210
|
+
- uses: actions/checkout@v4
|
|
211
|
+
- uses: AgentsKit-io/doc-bridge@v1.2.1
|
|
212
|
+
with:
|
|
213
|
+
config-path: doc-bridge.config.json
|
|
187
214
|
```
|
|
188
215
|
|
|
216
|
+
The Action checks the committed index before changing anything, pins the matching npm package, and rejects non-exact package versions. See the [Marketplace guide](docs/MARKETPLACE.md).
|
|
217
|
+
|
|
189
218
|
 
|
|
190
219
|
|
|
191
220
|
Run `ak-docs doctor --badge` locally to refresh — or `pnpm coverage:badge` in CI.
|
|
@@ -221,7 +250,9 @@ ak-docs rag ingest && ak-docs chat
|
|
|
221
250
|
|
|
222
251
|
See **[docs/chat-and-rag.md](docs/chat-and-rag.md)**.
|
|
223
252
|
|
|
224
|
-
##
|
|
253
|
+
## AgentsKit ecosystem
|
|
254
|
+
|
|
255
|
+
### Who uses it (public)
|
|
225
256
|
|
|
226
257
|
Designed for and dogfooded on open AgentsKit surfaces:
|
|
227
258
|
|
|
@@ -230,7 +261,7 @@ Designed for and dogfooded on open AgentsKit surfaces:
|
|
|
230
261
|
| **for-agents** | [agentskit.io/docs/for-agents](https://www.agentskit.io/docs/for-agents) |
|
|
231
262
|
| **Registry** | [registry.agentskit.io](https://registry.agentskit.io/) |
|
|
232
263
|
| **Playbook** | [playbook.agentskit.io](https://playbook.agentskit.io/llms.txt) |
|
|
233
|
-
| **AgentsKit Chat** | [chat
|
|
264
|
+
| **AgentsKit Chat** | [documentation](https://chat.agentskit.io) · [source](https://github.com/AgentsKit-io/agentskit-chat) |
|
|
234
265
|
| **AgentsKit OS** | [akos.agentskit.io](https://akos.agentskit.io) |
|
|
235
266
|
| **Code Review** | [repository-native CLI](https://github.com/AgentsKit-io/code-review-cli) |
|
|
236
267
|
| **This repo** | CI green · `ak-docs gate run` on every PR |
|
|
@@ -259,7 +290,7 @@ ak-docs memory promote --pr # opens draft PR via gh
|
|
|
259
290
|
|
|
260
291
|
## Status
|
|
261
292
|
|
|
262
|
-
**v1.
|
|
293
|
+
**v1.2.1 stable** — deterministic Documentation Standard v1 conformance, verified release provenance, Fumadocs portal, Marketplace Action, doctor + CI + skill, and full Tier A/B/C.
|
|
263
294
|
|
|
264
295
|
```bash
|
|
265
296
|
pnpm install && pnpm build && pnpm test
|
package/action.yml
CHANGED
|
@@ -18,46 +18,41 @@ inputs:
|
|
|
18
18
|
required: false
|
|
19
19
|
default: '22'
|
|
20
20
|
package-version:
|
|
21
|
-
description: npm
|
|
21
|
+
description: Exact @agentskit/doc-bridge npm version (kept in sync with this Action release)
|
|
22
22
|
required: false
|
|
23
|
-
default: ''
|
|
23
|
+
default: '1.2.1'
|
|
24
24
|
|
|
25
25
|
runs:
|
|
26
26
|
using: composite
|
|
27
27
|
steps:
|
|
28
28
|
- name: Setup Node
|
|
29
|
-
uses: actions/setup-node@v4
|
|
29
|
+
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v4
|
|
30
30
|
with:
|
|
31
31
|
node-version: ${{ inputs.node-version }}
|
|
32
32
|
|
|
33
33
|
- name: Install ak-docs
|
|
34
34
|
shell: bash
|
|
35
|
+
env:
|
|
36
|
+
DOC_BRIDGE_PACKAGE_VERSION: ${{ inputs.package-version }}
|
|
35
37
|
run: |
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
else
|
|
40
|
-
npm install -g @agentskit/doc-bridge
|
|
41
|
-
fi
|
|
42
|
-
|
|
43
|
-
- name: Build index
|
|
44
|
-
shell: bash
|
|
45
|
-
run: |
|
|
46
|
-
if [ -n "${{ inputs.config-path }}" ]; then
|
|
47
|
-
ak-docs index --config "${{ inputs.config-path }}"
|
|
48
|
-
else
|
|
49
|
-
ak-docs index
|
|
38
|
+
if [[ ! "$DOC_BRIDGE_PACKAGE_VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z.-]+)?$ ]]; then
|
|
39
|
+
echo "::error title=Invalid package-version::Use an exact semver version such as 1.2.1"
|
|
40
|
+
exit 2
|
|
50
41
|
fi
|
|
42
|
+
npm install -g "@agentskit/doc-bridge@${DOC_BRIDGE_PACKAGE_VERSION}"
|
|
51
43
|
|
|
52
44
|
- name: Run gates
|
|
53
45
|
shell: bash
|
|
46
|
+
env:
|
|
47
|
+
DOC_BRIDGE_CONFIG_PATH: ${{ inputs.config-path }}
|
|
48
|
+
DOC_BRIDGE_GATE_ID: ${{ inputs.gate }}
|
|
54
49
|
run: |
|
|
55
|
-
if [ -n "$
|
|
56
|
-
ak-docs gate run "$
|
|
57
|
-
elif [ -n "$
|
|
58
|
-
ak-docs gate run "$
|
|
59
|
-
elif [ -n "$
|
|
60
|
-
ak-docs gate run --config "$
|
|
50
|
+
if [ -n "$DOC_BRIDGE_GATE_ID" ] && [ -n "$DOC_BRIDGE_CONFIG_PATH" ]; then
|
|
51
|
+
ak-docs gate run "$DOC_BRIDGE_GATE_ID" --config "$DOC_BRIDGE_CONFIG_PATH"
|
|
52
|
+
elif [ -n "$DOC_BRIDGE_GATE_ID" ]; then
|
|
53
|
+
ak-docs gate run "$DOC_BRIDGE_GATE_ID"
|
|
54
|
+
elif [ -n "$DOC_BRIDGE_CONFIG_PATH" ]; then
|
|
55
|
+
ak-docs gate run --config "$DOC_BRIDGE_CONFIG_PATH"
|
|
61
56
|
else
|
|
62
57
|
ak-docs gate run
|
|
63
58
|
fi
|
|
@@ -65,9 +60,11 @@ runs:
|
|
|
65
60
|
- name: Doctor coverage (annotation)
|
|
66
61
|
shell: bash
|
|
67
62
|
continue-on-error: true
|
|
63
|
+
env:
|
|
64
|
+
DOC_BRIDGE_CONFIG_PATH: ${{ inputs.config-path }}
|
|
68
65
|
run: |
|
|
69
|
-
if [ -n "$
|
|
70
|
-
REPORT="$(ak-docs doctor --text --config "$
|
|
66
|
+
if [ -n "$DOC_BRIDGE_CONFIG_PATH" ]; then
|
|
67
|
+
REPORT="$(ak-docs doctor --text --config "$DOC_BRIDGE_CONFIG_PATH" 2>&1 || true)"
|
|
71
68
|
else
|
|
72
69
|
REPORT="$(ak-docs doctor --text 2>&1 || true)"
|
|
73
70
|
fi
|
package/dist/cli/program.js
CHANGED
|
@@ -1334,7 +1334,7 @@ var buildLookup = (config, packages, corpus, indexOutFile, humanDocs = {}, root
|
|
|
1334
1334
|
};
|
|
1335
1335
|
|
|
1336
1336
|
// src/version.ts
|
|
1337
|
-
var PACKAGE_VERSION = "1.
|
|
1337
|
+
var PACKAGE_VERSION = "1.2.1";
|
|
1338
1338
|
|
|
1339
1339
|
// src/index-builder/capabilities.ts
|
|
1340
1340
|
var renderCapabilitiesJson = (config, index, paths) => {
|