deepseek-harness/docs
Tianyi Cui 232f314c3a Add generated persistence log event catalog with freshness + completeness gates
docs/persistence-catalog/log-events.md enumerates every SessionEventMap
member — the owning dsh-session vocabulary plus the dsh-compact and
dsh-hook-protocol declaration merges — with payload, surface/log-only badge,
JSDoc prose, and declaration site. scripts/gen-persistence-catalog.ts is a
pure AST pass in the gen-cordis-catalog mold: verify-persistence-catalog
(--check) joins doc-sync, so a stale committed catalog fails pre-push and CI.

The walk enforces JSDoc completeness (every member needs description prose;
@mode is rejected as a category error — log events do not dispatch on the
cordis bus), derives the surface badge from the SurfaceEventType union with a
stale-member cross-check, and hard-errors on duplicate declarations. Payloads
render through the TypeScript printer so newline-separated multi-line type
literals still emit valid one-line fragments.

Documented the five previously JSDoc-less core events (turn/step boundaries,
tool/call), removed the two stray @mode tags on the hook/* merges, and
replaced the hand-restated event enumerations (session.md hook/* table,
compact README table, hook-protocol README bullets, session README name-list
— whose merge note had already drifted) with links to the catalog. RFC:
docs/rfc/implemented/process/2026-07-04-persistence-log-catalog.md.
2026-07-04 22:58:28 +08:00
..
cookbook fix(docs): address Codex review on the architecture rewrite 2026-07-04 16:28:38 +08:00
cordis-catalog Add JSDoc completeness gate for the cordis surface 2026-07-04 19:06:35 +08:00
core-data-structures Add generated persistence log event catalog with freshness + completeness gates 2026-07-04 22:58:28 +08:00
i18n docs: equal-authority pairing with sidecar consistency records 2026-07-03 07:41:24 -07:00
persistence-catalog Add generated persistence log event catalog with freshness + completeness gates 2026-07-04 22:58:28 +08:00
postmortem fix(docs): address Codex review round 3 — last three moved-policy citations 2026-07-04 16:02:39 +08:00
rfc Add generated persistence log event catalog with freshness + completeness gates 2026-07-04 22:58:28 +08:00
tool-catalog Merge remote-tracking branch 'origin/master' into web-capability-seam 2026-07-03 16:49:00 +08:00
AGENTS.md Add generated persistence log event catalog with freshness + completeness gates 2026-07-04 22:58:28 +08:00
architecture.md docs(architecture): rewrite the system map to the 1,800-word budget 2026-07-04 14:43:48 +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 simpl-0-rfc-index 2026-07-04 20:29:57 +08:00
development.md Merge remote-tracking branch 'origin/master' into simpl-0-rfc-index 2026-07-04 20:29:57 +08:00
development.zh.md Merge remote-tracking branch 'origin/master' into simpl-0-rfc-index 2026-07-04 20:29:57 +08:00
module-graph.md Merge branch 'worktree-hooks-e-protocol' into worktree-hooks-f-bridges 2026-07-04 03:09:37 +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