deepseek-harness/docs/rfc/implemented/process
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
..
2026-06-11-doc-sync-enforcement.md docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus 2026-07-05 22:58:25 +08:00
2026-06-11-quality-gates.md build: upgrade to 22.19 for deps 2026-07-07 17:39:04 +08:00
2026-06-11-tsdown-over-dumble.md docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus 2026-07-05 22:58:25 +08:00
2026-06-11-vendor-cordis-as-source.md docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus 2026-07-05 22:58:25 +08:00
2026-06-16-pnpm-over-yarn.md docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus 2026-07-05 22:58:25 +08:00
2026-06-17-ts-build-config.md docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus 2026-07-05 22:58:25 +08:00
2026-06-18-markdown-cross-link-lint.md docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus 2026-07-05 22:58:25 +08:00
2026-06-20-core-data-structures-catalog.md docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus 2026-07-05 22:58:25 +08:00
2026-06-20-generated-cordis-catalog.md docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus 2026-07-05 22:58:25 +08:00
2026-06-20-rfc-classification.md docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus 2026-07-05 22:58:25 +08:00
2026-07-02-bilingual-docs-and-pairing-gate.i18n.yaml docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus 2026-07-05 22:58:25 +08:00
2026-07-02-bilingual-docs-and-pairing-gate.md docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus 2026-07-05 22:58:25 +08:00
2026-07-02-bilingual-docs-and-pairing-gate.zh.md docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus 2026-07-05 22:58:25 +08:00
2026-07-02-tool-schema-catalog.md docs: flatten single-file catalog dirs to docs/tool-catalog.md and docs/persistence-catalog.md 2026-07-06 22:26:06 +08:00
2026-07-03-documentation-graph-atlas.md docs: flatten single-file catalog dirs to docs/tool-catalog.md and docs/persistence-catalog.md 2026-07-06 22:26:06 +08:00
2026-07-04-cordis-jsdoc-completeness-gate.md docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus 2026-07-05 22:58:25 +08:00
2026-07-04-doc-tiers-and-budgets.md docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus 2026-07-05 22:58:25 +08:00
2026-07-04-generate-rfc-index-tables.md docs(rfc): define and enforce a uniform RFC format; adopt it across the corpus 2026-07-05 22:58:25 +08:00
2026-07-04-persistence-log-catalog.md docs: flatten single-file catalog dirs to docs/tool-catalog.md and docs/persistence-catalog.md 2026-07-06 22:26:06 +08:00
2026-07-05-uniform-rfc-format.md docs(rfc): align the no-Status-line alternative's file count with the measured one 2026-07-05 23:56:11 +08:00
2026-07-06-export-surface-jsdoc-gate.md fix review findings: CI leaf-gate wiring, heritage return surface, AGENTS.md self-containedness 2026-07-07 20:30:34 +08:00
2026-07-06-generated-config-catalog.md fix: extend the schema cross-check to nested key paths; scope the catalog framing 2026-07-06 23:06:03 +08:00
2026-07-06-node-engine-floor.md build: upgrade to 22.19 for deps 2026-07-07 17:39:04 +08:00
2026-07-06-parallel-github-ci-gates.md ci: keep measured e2e worker cap 2026-07-06 03:20:08 +08:00
2026-07-06-parallel-pre-push-gates.md Merge parallel pre-push gates into CI scheduler 2026-07-06 01:47:13 +08:00
2026-07-10-readme-known-limitations-gate.md Add a gated Known Limitations and Deferred Work section to every package README 2026-07-12 01:46:34 +08:00