Builds an API reference with typedoc

.claude/diataxis.md

@@ -0,0 +1,41 @@
+---
+# The docs manifest the documentation tools read. Generated from the family's manifest
+# table: change a key there and regenerate. The two prose lines below may be sharpened.
+product: "@riddler/predicator"
+family: statifier
+audience: "TypeScript developers evaluating rules in a browser, Node or React Native"
+tone: "plain, second person, no marketing"
+terminology:
+  use:
+    - execution
+    - chart
+    - document
+    - revision
+  avoid:
+    - "run (noun)"
+    - workflow instance
+example_world: library-loan
+docs_root: docs
+quadrants:
+  tutorials: docs/tutorials
+  how_to: docs/guides
+  reference: docs/reference
+  explanation: docs/explanation
+readme: README.md
+reference_generator: typedoc
+publish: site-later
+contributor_paths:
+  - docs/adr
+  - docs/plans
+  - docs/spikes
+  - docs/research
+  - docs/design
+  - docs/measurements
+  - CLAUDE.md
+executed_snippets:
+  - test/readme.test.ts
+readme_max_lines: 1200
+---
+
+The same predicate language in TypeScript, corpus-identical to the Elixir evaluator.
+Examples are written in the library loan: a copy of a book lent to a patron, due, renewed, returned or lost.

.claude/firewall-allow.txt

@@ -0,0 +1,9 @@
+# Exact strings the maintainers' planning-reference scan may pass. One exact
+# string per line; a line starting with "# " is a comment. An entry allows a
+# match only where the entry's text covers it on the same line.
+
+# pnpm-lock.yaml: the integrity value of brace-expansion 5.0.12. The scan
+# reads base64 as prose and a run inside this hash takes an id's shape; no
+# planning reference is involved. Allowed by a ruling of the operator,
+# 2026-10-05.
+sha512-YovQ3rzhaLMIrDjNDMkNS01tea93qhEhG5xy8f6+R0l+dw3Ki+5sCoIoI942iuLZTHWogWktgwVDhU09iNEimQ==

.gitignore

@@ -18,6 +18,10 @@ dist/
 coverage/
 reports/
 
+# The generated API reference, built by `pnpm run docs` (typedoc.json). It is
+# built locally and checked by the gate, and never committed.
+/docs/api/
+
 # Temporary files, for example, from tests.
 /tmp/
 

README.md

@@ -1060,6 +1060,8 @@ and is mirrored here in a later release. The records under `docs/adr/` are what
 this package decided for itself: what kind of thing it is, the value domain and
 the host boundary, the conformance apparatus, and the compiler surface.
 
+`mise exec -- pnpm run docs` builds the API reference locally, into `docs/api/`.
+
 ## Development
 
 ```bash

package.json

@@ -49,13 +49,14 @@
   },
   "scripts": {
     "prepack": "node scripts/publish-guard.mjs",
-    "gate": "node --version && pnpm run typecheck && pnpm run lint && pnpm run neutrality && vitest run --coverage && pnpm run corpus:check && pnpm run cites && pnpm run build && pnpm run identity && pnpm run resolution",
+    "gate": "node --version && pnpm run typecheck && pnpm run lint && pnpm run neutrality && vitest run --coverage && pnpm run corpus:check && pnpm run cites && pnpm run build && pnpm run identity && pnpm run resolution && pnpm run docs",
     "gate:loop": "pnpm run typecheck && pnpm run lint && pnpm run test",
     "typecheck": "tsc --noEmit -p tsconfig.src.json && tsc --noEmit",
     "lint": "biome check .",
     "format": "biome format --write .",
     "test": "vitest run",
     "build": "tsup",
+    "docs": "typedoc",
     "neutrality": "node scripts/engine-neutrality.mjs",
     "corpus:check": "node scripts/corpus-check.mjs",
     "cites": "node scripts/record-cites.mjs",
@@ -70,6 +71,7 @@
     "@vitest/coverage-v8": "5.0.1",
     "tsup": "8.5.1",
     "tsx": "4.23.13",
+    "typedoc": "0.28.20",
     "typescript": "5.9.3",
     "vitest": "5.0.1"
   }