deepseek-harness/docs/rfc
Tianyi Cui 6a528be569 build: doc-sync gates — typecheck doc code blocks + verify event taxonomy (RFC 006 pts 1-2)
Two tsx CI gates make doc/code drift fail fast:
- doc-typecheck extracts every fenced ts block from README/docs/package READMEs,
  compiles them with tsc --noEmit against a temp project (vendor->lib, harness->src
  paths from tsconfig.typecheck.json), and fails on errors. Deliberate sketches opt
  out with ```ts ignore-check; the opt-out ratio is reported and capped.
- verify-event-taxonomy asserts the docs/architecture.md taxonomy table names
  exactly the events declared in the interface Events blocks. This surfaced three
  events the table had been missing (tools/change, llm/adapter-change,
  system-prompt/change), now added.

Doc snippets made compilable with stub imports/declares (1 genuine sketch ignored).
Wired into CI after typecheck. API reports (RFC 006 pt 3) deferred. Graduates RFC
006 pts 1-2 -> ADR 0014.
2026-06-14 00:47:38 +08:00
..
001-property-based-testing.md test: property-based tests for protocol-shaped code (RFC 001) 2026-06-14 00:06:25 +08:00
002-mutation-testing.md docs: unwrap hard-wrapped Markdown to one line per paragraph 2026-06-13 20:27:04 +08:00
003-deterministic-and-stress-testing.md docs: unwrap hard-wrapped Markdown to one line per paragraph 2026-06-13 20:27:04 +08:00
004-architectural-conformance.md docs: unwrap hard-wrapped Markdown to one line per paragraph 2026-06-13 20:27:04 +08:00
005-runtime-validation-and-error-taxonomy.md fix(invariants): address Codex review of dev invariants (PR 2) 2026-06-13 23:50:43 +08:00
006-doc-sync-and-api-reports.md build: doc-sync gates — typecheck doc code blocks + verify event taxonomy (RFC 006 pts 1-2) 2026-06-14 00:47:38 +08:00
007-supply-chain-and-vendor-drift.md docs: unwrap hard-wrapped Markdown to one line per paragraph 2026-06-13 20:27:04 +08:00
008-immutable-public-surfaces.md fix(invariants): address Codex review of dev invariants (PR 2) 2026-06-13 23:50:43 +08:00
README.md build: doc-sync gates — typecheck doc code blocks + verify event taxonomy (RFC 006 pts 1-2) 2026-06-14 00:47:38 +08:00

RFCs

Proposals for substantial future work — reviewed before implementation, unlike ADRs (which record decisions already made). Each RFC groups a related set of ideas from the quality/robustness proposal (2026-06-11); statuses move proposed → accepted → implemented (then usually graduate to an ADR).

# Title Status
001 Property-based testing for protocol-shaped code implemented
002 Mutation testing as the coverage counterweight proposed
003 Deterministic tests + replay invariant fixture + race stress proposed
004 Architectural rules: dependency-cruiser, adapter conformance kit proposed
005 Runtime arg validation, structured error taxonomy, dev-mode invariants partially implemented
006 Doc-sync enforcement and API extractor reports implemented (pts 1-2; pt 3 deferred)
007 Supply chain checks and vendor drift verification proposed
008 Deep-readonly public surfaces implemented (revised)