deepseek-harness/docs
Tianyi Cui ecb8aa5b8e Add a gated Known Limitations and Deferred Work section to every package README
Every packages/*/* README now carries a canonical '## Known Limitations and
Deferred Work' section: condensed, evidence-backed bullets for consumer-visible
gaps (unimplemented features, platform caveats, MVP cuts) and consciously
postponed work (TODO/FIXME/XXX markers, RFC deferrals still open). The ten
pre-existing ad-hoc variants ('What is NOT here (TODO)', 'Deferred',
'Limitations (MVP)', 'Known limitations (tracked TODOs)', ...) are normalized
into the canonical heading.

A new doc-sync gate, scripts/verify-readme-limitations.ts, enforces the shape:
exactly one limitations-like heading per package README, byte-equal to the
canonical h2, with at least one bullet; near-miss headings fail so variants
cannot creep back. Packages with genuinely nothing to declare (dsh-brand,
dsh-timeout, dsh-subagent-mock, dsh-app-boot) are whitelisted in the script and
must NOT carry the section; whitelist entries are validated against the scanned
package set so a rename fails loud.

Wired into the doc-sync chain (package.json) and the run-gates doc-sync leaf
set; the standing rule lands in packages/AGENTS.md and the adding-a-package
cookbook; decision record in
docs/rfc/implemented/process/2026-07-10-readme-known-limitations-gate.md
(RFC index regenerated).

Also fixes two stale '(deferred)' markers claiming dsh-compact-basic is
unimplemented (the dsh-compact seam README's package table and the seam's
module doc comment).
2026-07-12 01:46:34 +08:00
..
cookbook Add a gated Known Limitations and Deferred Work section to every package README 2026-07-12 01:46:34 +08:00
cordis-catalog fix(scope): close final ownership races 2026-07-12 00:31:46 +08:00
core-data-structures fix(scope): close final ownership races 2026-07-12 00:31:46 +08:00
i18n docs: equal-authority pairing with sidecar consistency records 2026-07-03 07:41:24 -07:00
postmortem fix(docs): address Codex review round 3 — last three moved-policy citations 2026-07-04 16:02:39 +08:00
rfc Add a gated Known Limitations and Deferred Work section to every package README 2026-07-12 01:46:34 +08:00
agent-lifecycle.md docs: align the agent-scope contracts 2026-07-11 22:55:40 +08:00
AGENTS.md make wordcount budget guidance clearer and dedup docs 2026-07-10 00:20:35 +08:00
architecture.md Merge remote-tracking branch 'origin/master' into codex/pr224-rfc-rewrite 2026-07-11 23:14:09 +08:00
capability-seams.md Merge remote-tracking branch 'origin/master' into codex/pr224-rfc-rewrite 2026-07-11 23:14:09 +08:00
config-catalog.md fix(scope): close final ownership races 2026-07-12 00:31:46 +08:00
cordis-primer.md a human touch 2026-07-09 23:48:29 +08:00
defensive-patterns.md docs(AGENTS): rewrite the root standing orders to the 1,500-word budget 2026-07-04 14:22:47 +08:00
development.i18n.yaml Merge remote-tracking branch 'origin/master' into worktree-node-22-18-compat 2026-07-07 21:33:40 +08:00
development.md Merge remote-tracking branch 'origin/master' into worktree-node-22-18-compat 2026-07-07 21:33:40 +08:00
development.zh.md Merge remote-tracking branch 'origin/master' into worktree-node-22-18-compat 2026-07-07 21:33:40 +08:00
event-producer-consumer.md fix(scope): close final ownership races 2026-07-12 00:31:46 +08:00
graph-atlas.md chore: register the cordis group across repo gates and docs 2026-07-09 13:57:03 +08:00
module-graph.md Merge remote-tracking branch 'origin/master' into codex/pr224-rfc-rewrite 2026-07-11 23:14:09 +08:00
persistence-catalog.md fix(scope): close final ownership races 2026-07-12 00:31:46 +08:00
testing.md Add keyless snapshot refresh mode 2026-07-10 00:48:27 +08:00
tool-catalog.md Merge remote-tracking branch 'origin/master' into codex/pr224-rfc-rewrite 2026-07-11 23:14:09 +08:00
tool-execution-pipeline.md Merge remote-tracking branch 'origin/master' into codex/pr224-rfc-rewrite 2026-07-11 23:14:09 +08:00