Skip to content

docs: add generated error code reference - #14

Merged
daichunghy merged 2 commits into
mainfrom
docs/error-code-reference
Aug 25, 2026
Merged

docs: add generated error code reference#14
daichunghy merged 2 commits into
mainfrom
docs/error-code-reference

Conversation

@daichunghy

Copy link
Copy Markdown
Owner

Summary

Closes #9

Adds docs/ERRORS.md for the quantitative research contracts. The reference distinguishes the 23
registered codes from the 22 codes currently emitted by source call sites and records cause,
source locations and smallest input fix.

The validator is wired into npm run verify and fails when the registry, emitted codes or document
drift apart. empty_operations is retained as a registered-but-not-currently-emitted code rather
than being silently removed.

Verification

  • npm run verify on Node 22
  • 34 tests pass
  • error validator: 23 registered, 22 emitted
  • schema, package, secret scan and CLI smoke checks pass
  • git diff --check passes

Boundary

No public API or runtime behavior changed. Demonstration items remain demonstrations; no research
provenance, external users or adoption is claimed.

@daichunghy
daichunghy merged commit f77893a into main Aug 25, 2026
2 checks passed
@daichunghy
daichunghy deleted the docs/error-code-reference branch August 25, 2026 03:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: error-code reference (code → cause → fix)

1 participant