[GH-ISSUE #643] docs:api broken under TypeScript 7 (typedoc incompatible) #304

Closed
opened 2026-10-15 18:23:41 +00:00 by bsakaguchi · 1 comment
Owner

Originally created by @morluto on GitHub (Oct 5, 2026).
Original GitHub issue: https://github.com/morluto/rea/issues/643

Found while upgrading to TypeScript 7 (#633, #637-follow-up).

typedoc 0.28.20 declares peer typescript <=6.x and crashes at runtime on TS 7 (ts.SyntaxKind undefined — tsgo API shape differs). typedoc 1.0.0-dev.4 (peer >=4.0.0) installs but crashes the same way. So npm run docs:api cannot run on the current toolchain. npm install (re-resolution) also hard-fails on the typedoc peer edge; only npm ci from the locked tree works.

Options: (a) drop typedoc + docs:api workflow, (b) wait for a TS7-compatible typedoc, (c) pin a TS6 sidecar just for docs generation. Needs a product call — docs:api output is a committed workflow (typedoc.json, turbo docs:api task).

Originally created by @morluto on GitHub (Oct 5, 2026). Original GitHub issue: https://github.com/morluto/rea/issues/643 Found while upgrading to TypeScript 7 (#633, #637-follow-up). typedoc 0.28.20 declares peer typescript <=6.x and crashes at runtime on TS 7 (`ts.SyntaxKind` undefined — tsgo API shape differs). typedoc 1.0.0-dev.4 (peer >=4.0.0) installs but crashes the same way. So `npm run docs:api` cannot run on the current toolchain. `npm install` (re-resolution) also hard-fails on the typedoc peer edge; only `npm ci` from the locked tree works. Options: (a) drop typedoc + docs:api workflow, (b) wait for a TS7-compatible typedoc, (c) pin a TS6 sidecar just for docs generation. Needs a product call — docs:api output is a committed workflow (typedoc.json, turbo docs:api task).
bsakaguchi 2026-10-15 18:23:41 +00:00
Author
Owner

@morluto commented on GitHub (Oct 5, 2026):

Resolved by removing TypeDoc: nothing in any gate used it, and it is incompatible with TypeScript 7 at both install and runtime. API HTML rendering (docs:api), typedoc.json, the CI artifact step, and related docs were removed.

<!-- gh-comment-id:6003750081 --> @morluto commented on GitHub (Oct 5, 2026): Resolved by removing TypeDoc: nothing in any gate used it, and it is incompatible with TypeScript 7 at both install and runtime. API HTML rendering (docs:api), typedoc.json, the CI artifact step, and related docs were removed.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
morluto/rea#304
No description provided.