docs: sync implementation docs and doc gates

This commit is contained in:
kingwl
2026-07-01 10:29:47 +08:00
parent 3f85f522ea
commit 643b77dabf
15 changed files with 78 additions and 50 deletions
+7
View File
@@ -78,6 +78,7 @@ The GitHub workflow runs these gates on each pull request:
- `pnpm run build`
- `pnpm run hygiene`
- an echo-agent smoke test that checks the demo's tool call, tool result, and JSONL output
- built-bin smoke tests that run the published `lib/bin.js` entrypoints under plain `node`
`pnpm run hygiene` is the local shorthand for `pnpm run knip && pnpm run publint && pnpm run constraints && pnpm run verify-node-next-types`; CI also runs `pnpm run constraints` as an earlier fail-fast step, then runs the full hygiene script after `pnpm run build`.
@@ -121,6 +122,12 @@ The coding-agent demo uses the real DeepSeek adapter and needs `DEEPSEEK_API_KEY
pnpm run demo:coding
```
The ACP server demo exposes the same coding agent over JSON-RPC stdio and also needs `DEEPSEEK_API_KEY`:
```sh
pnpm run demo:acp
```
## TODO markers
Use one of three comment tags to flag known issues in the code, ordered by urgency: