Skip to content

docs(website): exact-name guards for the TypeDoc anchor rewrite and the authored-label check (#610 follow-up) - #624

Merged
ScriptedAlchemy merged 2 commits into
mainfrom
docs/590-anchor-guards
Sep 5, 2026
Merged

docs(website): exact-name guards for the TypeDoc anchor rewrite and the authored-label check (#610 follow-up)#624
ScriptedAlchemy merged 2 commits into
mainfrom
docs/590-anchor-guards

Conversation

@ScriptedAlchemy

@ScriptedAlchemy ScriptedAlchemy commented Sep 5, 2026

Copy link
Copy Markdown
Owner

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#name rewrite now also requires the link's label to equal the ### member's exact name. Ids are case-folded, so type FooCode and const fooCode share the base foocode; 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 on main, 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 as EvalRunStoreError.codeevalrunstoreerrorcode), 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 moving id="build-2" onto the <h5> build property 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.ts entries (app/index.tsapp); now "source path with .ts and a trailing /index dropped", with app as the example. createAppClient in "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 on PageAnchors.members that restated memberName. 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 the claude-fable-5-1-thinking-high findings 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.

… exactly; module-page naming covers */index.ts entries (#610 review)
@ScriptedAlchemy ScriptedAlchemy added the skip-changeset PR changes a publishable package but ships no observable change; changeset not required label Sep 5, 2026
@changeset-bot

changeset-bot Bot commented Sep 5, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: c3f9e91

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@pkg-pr-new

pkg-pr-new Bot commented Sep 5, 2026

Copy link
Copy Markdown
npm i https://pkg.pr.new/ScriptedAlchemy/agent-bundle@624
npm i https://pkg.pr.new/ScriptedAlchemy/agent-bundle/create-agent-bundle@624
npm i https://pkg.pr.new/ScriptedAlchemy/agent-bundle/rsc-markdown-stream@624
npm i https://pkg.pr.new/ScriptedAlchemy/agent-bundle/@agent-bundle/runtime@624

commit: c3f9e91

@ScriptedAlchemy
ScriptedAlchemy marked this pull request as ready for review September 5, 2026 09:56
@ScriptedAlchemy
ScriptedAlchemy merged commit 9b02115 into main Sep 5, 2026
13 checks passed
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 5, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-05T09:59:29.462655Z c3f9e91 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-changeset PR changes a publishable package but ships no observable change; changeset not required

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant