deepseek-harness/docs
Tianyi Cui cd9737d569 Gate JSDoc completeness on every package export
New doc-sync gate verify-export-jsdoc walks every module-level exported
name under packages/*/*/src and requires description prose everywhere,
plus @param per parameter and @returns on non-void annotated returns for
function-like exports, public class methods, properties, and accessors.
The parsing + check helpers move out of gen-cordis-catalog.ts into a
shared scripts/jsdoc.ts so 'documented' means one thing on both gated
surfaces.

Deliberate exemptions (documented in the RFC): heritage-declared class
members (the seam declaration is the doc's one home — the one checker
query in an otherwise pure-AST walk), cordis plugin-protocol slots
(name/inject/reusable/Config/apply, top-level and static), constructors,
overload implementations, declare-module augmentation bodies, and
re-export statements (checked at the defining module).

The 203 under-documented exports the gate found at adoption are filled
in this change, so the gate lands green; generated catalogs/graphs are
regenerated for the shifted line pointers.

RFC: docs/rfc/implemented/process/2026-07-06-export-surface-jsdoc-gate.md
2026-07-06 22:09:30 +08:00
..
cookbook docs: the governing principle — every LLM request is reconstructable from the session log 2026-07-06 03:49:35 +08:00
cordis-catalog Gate JSDoc completeness on every package export 2026-07-06 22:09:30 +08:00
core-data-structures docs: the governing principle — every LLM request is reconstructable from the session log 2026-07-06 03:49:35 +08:00
i18n docs: equal-authority pairing with sidecar consistency records 2026-07-03 07:41:24 -07:00
persistence-catalog Gate JSDoc completeness on every package export 2026-07-06 22:09:30 +08:00
postmortem fix(docs): address Codex review round 3 — last three moved-policy citations 2026-07-04 16:02:39 +08:00
rfc Gate JSDoc completeness on every package export 2026-07-06 22:09:30 +08:00
tool-catalog Merge remote-tracking branch 'origin/master' into codex/docs-graph-brainstorm 2026-07-05 02:16:26 +08:00
agent-lifecycle.md docs: address graph review placement 2026-07-05 02:54:01 +08:00
AGENTS.md Clarify condensing in doc budget guidance 2026-07-06 16:31:18 +08:00
architecture.md fix review findings: one frozen seed through the waterfall; stale agent/request docs 2026-07-06 04:17:29 +08:00
capability-seams.md docs: address graph review placement 2026-07-05 02:54:01 +08:00
cordis-primer.md docs: split cordis primer from architecture map 2026-07-05 19:07:34 +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 Gate JSDoc completeness on every package export 2026-07-06 22:09:30 +08:00
development.md Gate JSDoc completeness on every package export 2026-07-06 22:09:30 +08:00
development.zh.md Gate JSDoc completeness on every package export 2026-07-06 22:09:30 +08:00
event-producer-consumer.md Gate JSDoc completeness on every package export 2026-07-06 22:09:30 +08:00
graph-atlas.md Move ACP snapshot replay doc into package 2026-07-06 00:52:06 +08:00
module-graph.md Merge origin/master: adopt the DeepSeek Harness SDK product name 2026-07-05 20:54:48 +08:00
testing.md fix(docs): address ds-review-bot — the e2e tier is not DeepSeek-only 2026-07-04 16:43:23 +08:00
tool-execution-pipeline.md docs: address graph review placement 2026-07-05 02:54:01 +08:00