Repository navigation
Builds an API reference with typedoc - #207
Merged
Merged
Conversation
Adds typedoc as an exact-pinned dev dependency and a typedoc.json naming the two public entry points (the main entry and ./tagged), with the README as the index page and warnings treated as errors. The output goes to docs/api/, which is git-ignored: the reference is built locally by `pnpm run docs`, and the full gate runs that script as its last stage, a build check only. The existing gate stages are unchanged. HostContext is referenced by ExecuteResult but not exported, so the config lists it as intentionally not exported rather than changing any source file. Adds the docs manifest the documentation tools read, at .claude/diataxis.md, and one README line naming the docs command. Refs: pts-uhhm
The planning-reference scan reads the lockfile's base64 integrity value for brace-expansion 5.0.12 as prose, and a run inside it takes an id's shape. The allowlist covers that one exact string; no planning reference is involved. Allowed by a ruling of the operator, 2026-10-05. Refs: pts-uhhm
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Builds an API reference for the package with typedoc, from the TSDoc comments the source already carries, with the README as its index page. The reference is built locally and checked by the gate; nothing is committed or published.
typedoc0.28.20 is an exact-pinned dev dependency (the lockfile is updated).typedoc.jsonnames the two public entry points (src/index.tsandsrc/tagged.ts, the same entriestsup.config.tsbuilds and theexportsmap names), readstsconfig.src.json, usesREADME.mdas the index, writes todocs/api/and treats warnings as errors.docs/api/is git-ignored.package.jsongains adocsscript, and thegatescript runs it as its last stage, a build check only. Every existing gate stage is unchanged and in its original order.mise exec -- pnpm run docs..claude/diataxis.mdis the docs manifest the documentation tools read, as generated for this repository; its two prose lines are kept as generated, and the example world is the library loan..claude/firewall-allow.txtallows one exact string: the lockfile integrity value of brace-expansion 5.0.12, a transitive dependency of typedoc. It is allowlisted by a ruling of the operator, 2026-10-05, because the planning-id scan reads base64 as prose (no planning id is involved).No file under
src/changes, and there is no changelog fragment (changelog.d/README.mdexcludes documentation and tooling changes).Provenance
HostContextis referenced byExecuteResultbut is not exported, which is the one warning typedoc raises at the base. The config lists it underintentionallyNotExportedinstead of changing the source: decided by the conductor under a standing consent, 2026-10-05.Verification
mise exec -- pnpm run gate) green on the branch, including the new docs stage.intentionallyNotExportedentry makespnpm run docsfail on that warning (exit 4), so the warnings-as-errors setting is live; the file was restored byte-identical.