Skip to content

docs: compact generated API reference to one file per module (977→13)#345

Merged
drewstone merged 1 commit into
mainfrom
docs/compact-api
Jun 18, 2026
Merged

docs: compact generated API reference to one file per module (977→13)#345
drewstone merged 1 commit into
mainfrom
docs/compact-api

Conversation

@drewstone

Copy link
Copy Markdown
Contributor

Follow-up to #344. Per-symbol TypeDoc output was 977 stub files / 4.3M — wrong strategy for a committed reference (verbose, noisy diffs). Switch to outputFileStrategy: modules → 13 readable pages (one per public module, ~1.2M), signatures + TSDoc inline. Gate's export-universe parser now reads module-page headings (robust to either layout). Verified: docs:freshness passes + still catches injected drift; docs:check exit 0 (deterministic regen).

The per-symbol output (977 stub files / 4.3M) was the wrong strategy for a committed reference —
verbose to browse, noisy in diffs. Switch typedoc-plugin-markdown to outputFileStrategy: modules:
one readable page per public module (13 files / 1.2M), signatures + TSDoc inline. Teach the freshness
gate's export-universe parser to read symbols from the module-page headings (h3..h6) instead of
per-symbol filenames — robust to either layout. Gate still passes + still catches drift (verified:
injected ghost §2 symbol -> exit 1; docs:check -> exit 0, regen deterministic).

@tangletools tangletools left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Auto-approved PR — b0db788e

Blanket team auto-approval is enabled for this reviewer service.
The full PR reviewer audit still runs separately and will publish findings if it detects issues.

tangletools · auto-approval · reason: blanket_auto_approve · 2026-06-18T22:22:50Z

@drewstone drewstone merged commit 77b73d9 into main Jun 18, 2026
1 check passed
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.

2 participants