docs(api): every visible catalog row informative — tag-position fix, TSDoc backfill, collapse undocumented types, ratchet#448
Merged
Conversation
…TSDoc backfill, collapse undocumented types, ratchet
tangletools
approved these changes
Jul 2, 2026
tangletools
left a comment
Contributor
There was a problem hiding this comment.
✅ Auto-approved drewstone PR — ce78ddc8
This PR was opened by the trusted drewstone account.
The full PR reviewer audit still runs separately and will publish findings if it detects issues.
tangletools · auto-approval · reason: drewstone_author · 2026-07-02T22:22:19Z
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
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.
What
The primitive catalog (docs/api/primitive-catalog.md) is the anti-reinvention inventory, but 629 of its 1366 rows (46%) printed the same "(no summary…)" placeholder, destroying the scannability that is the artifact's whole job. This PR makes every visible table row informative, four layers:
@experimental/@stableas their FIRST content line with a real description after it; the TS compiler classes everything after a block tag as tag content, sogetDocumentationCommentreturned empty and the row rendered blank. The tag now sits at the END of each block (TSDoc-correct: summary first, tags last). Recovers 38 catalog rows for free (e.g.openSandboxRun,Deliverable,runDelegatedLoop).supervise,runLoop,createScope/createEventBus/createInbox/supervisorAgent, the RSI verbs (sample/refine/observe/runStrategyEvolution/promotionGate/harvestCorpus), the lifecycle entrypoints (runAgentTask/runAgentTaskStream/runConversationStream), sandbox/workspace seams,createMcpServer, the loop-runner family, the improvement generators,BenchmarkReport,ExecCtx. Wording condensed from the existing file-header docs + canonical-api.md.A,B, …" paragraph. Names stay backticked/greppable; existence is still proven. (Verified: check-docs-freshness.mjs resolves symbols from TypeDoc page headings, never from catalog table rows, so nothing in the gate needed a matcher change.)maxUndocumentedCallables = 108(the exact current count). Rides the existingpnpm docs:check— no new CI job. New callables must ship with a TSDoc summary; the constant only ever moves down.Numbers
Verification
pnpm run lint/pnpm run typecheck(incl. examples) /pnpm test— 122 files, 1194 passed, 2 skipped.pnpm run build && pnpm run docs:api && pnpm run docs:check— green; regenerated docs/api committed.Follow-up (upstream)
33 of the remaining 108 blank callables are agent-eval re-exports (CAMPAIGN 24, JUDGE 7, VERIFICATION 2) that genuinely lack TSDoc at their dist declarations — needs an agent-eval issue (incl. the tsup dts comment-detachment case where
heldOutGate's description lands onHeldOutGateOptions); this catalog auto-heals on the next version bump.