docs(website): exact-name guards for the TypeDoc anchor rewrite and the authored-label check (#610 follow-up) - #624
Conversation
… exactly; module-page naming covers */index.ts entries (#610 review)
|
commit: |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Follow-up to #610 from its final review pass (
claude-fable-5-1-thinking-high), which ran while auto-merge landed the PR; three non-blocking hardening items, no page or route changes. Website-only →skip-changeset.website/plugins/mirror-api-locale.ts— the#name-N→#namerewrite now also requires the link's label to equal the###member's exact name. Ids are case-folded, sotype FooCodeandconst fooCodeshare the basefoocode; with a third same-slug reflection TypeDoc emits[fooCode](#foocode-2), which the old rule would have re-pointed at the type alias while passing every anchor check. The reviewer reproduced that against the plugin; the pattern (AgentEventPayloadFields/agentEventPayloadFields) already exists onmain, only the third collision is missing today. Output on the current tree is unchanged: 1,958 intra-page links, 0 dead, 168 legitimately suffixed links untouched. Fence stripping accepts 4+ backtick fences. The JSDoc now names the actual cause of the spurious suffix (TypeDoc's first anchor pass allocating compound slugs such asEvalRunStoreError.code→evalrunstoreerrorcode), not "reserved names".website/scripts/check-built-links.mjs— the authored-label check compares case-sensitively and requires the target to be an<h3>module member; a trailing?on an optional-property heading is ignored. The reviewer showed that movingid="build-2"onto the<h5>buildproperty passed the old case-insensitive check. All 94 authored links pass the stricter rule.reference/api.mdx(en + zh) — "named after the entry point's source file" was wrong for the five*/index.tsentries (app/index.ts→app); now "source path with.tsand a trailing/indexdropped", withappas the example.createAppClientin "Where to start" links to its heading like the other bullets.Gate (
pnpm docs:site:build): typecheck, drift 0/34 pairs, 0 broken links / 26,558 anchors, 94 labels matched.Deslop
cursor-grok-4.6-high-fast, 1 edit (c3f9e91): a field comment onPageAnchors.membersthat restatedmemberName. No casts, try/catch, nesting, or en/zh drift to fix.Self-review
Reviewer:
gpt-5.6-sol-medium(author:claude-fable-5-1-thinking-max, implementing theclaude-fable-5-1-thinking-highfindings from #610's final pass). No findings: old and new link regexes match the identical 179-link set over the generated markdown; label normalisation leaves no guarded link dead; checker captures,?handling and<h3>rule verified against every authored target; en/zh links correspond (28/28); all 15 entry points follow the documented naming rule; gate re-run by the reviewer (0 broken / 26,558 anchors / 94 labels).Refs #610, #590.