fix(docs): pin typedoc and TypeScript so the Pages deploy builds again - #44
Merged
Merged
Conversation
npx typedoc was unpinned, so it fetched the latest typedoc (0.28.20), which pulls TypeScript 6 as its peer. TS 6 rejects src/ts/tsconfig.json's target=ES5 and moduleResolution=node10 (TS5107), failing the docs deploy on every push to main since at least 2026-08-20. Pin typescript@5.7.3, the version the library already builds with, and typedoc@0.28.20. Changing the tsconfig instead would change the JavaScript the published client emits. Verified locally: unpinned exits 3 with the same two errors as CI; pinned exits 0 and generates the docs. Claude-Session: https://claude.ai/code/session_014J7s5yzoVEqoZ8LmnD8bQd
benfrank241
approved these changes
Sep 23, 2026
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
2 participants
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.
The docs deploy (
CI→deploy, GitHub Pages) has failed on every push tomainsince at least 2026-08-20, including today's merges of #40 and #43.Cause:
scripts/generate-docs.shrunsnpx typedocunpinned, so it fetches the latest typedoc (0.28.20). That pulls in TypeScript 6 as its peer, and TypeScript 6 turnssrc/ts/tsconfig.json'starget: es5andmoduleResolution: nodeinto hard errors:Fix: pin
typescript@5.7.3, which is what the library itself builds with, plustypedoc@0.28.20. Changing the tsconfig instead would change the JavaScript the published client emits.Verified locally: unpinned exits 3 with the same two errors as CI. Pinned exits 0 and generates the docs. The remaining
@exporttag warnings are cosmetic and pre-existing.https://claude.ai/code/session_014J7s5yzoVEqoZ8LmnD8bQd