Skip to content

docs: remove stale table of contents entries in adding-pages guide - #9204

Open
ump45nose wants to merge 1 commit into
nodejs:mainfrom
ump45nose:docs/remove-stale-adding-pages-toc-entries
Open

ump45nose wants to merge 1 commit into
nodejs:mainfrom
ump45nose:docs/remove-stale-adding-pages-toc-entries

Conversation

@ump45nose

Copy link
Copy Markdown

Description

docs/adding-pages.md shipped a table of contents that links three
sections which no longer exist in the document, so the anchors are dead:

  • #learn-page-frontmatter (Learn Page Frontmatter)
  • #frontmatter-fields (Frontmatter Fields, nested under the entry above)
  • #accessible-components (Accessible Components)

Verified by extracting every ##/### heading of the file, GitHub-style
slugifying it, and checking each same-file ](#...) TOC link against
those slugs — exactly these three did not resolve. The "Learn Page
Frontmatter" content is not covered anywhere else (the section only
documents structure, navigation and translation keys), and the
"Accessible Components" content lives under "Content Guidelines"
without a heading of its own.

The fix removes the three stale TOC entries; no other text changes.
After the edit the same anchor check reports zero broken links.

Validation

  • Prettier (repo config .prettierrc.json, prettier 3.9.6 +
    prettier-plugin-tailwindcss): All matched files use Prettier code style!
  • Anchor check over the edited file: remaining broken anchors: []
  • CI unit tests (pnpm test) could not be executed in this environment:
    the repo pins engines.node >= 24.11.0 while the sandbox ships Node
    v22.23.2, so pnpm install/turbo cannot run. The change only deletes
    three list lines from a Markdown file and touches no code path, so it
    does not affect any unit test surface.

Related Issues

No existing issue for this dead-anchor cleanup; this is a short errata.

Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I have run pnpm format equivalent on the changed file (prettier with repo config passes; see Validation for the toolchain caveat).
  • I have run pnpm test (not possible in this environment — Node 22 vs engines >=24.11.0; docs-only change).
  • I have run pnpm build (same toolchain caveat as above).
  • No new functionality added, so no new unit tests required.

The table of contents still linked to "Learn Page Frontmatter",
"Frontmatter Fields" and "Accessible Components" sections that no
longer exist in the document, producing three dead anchor links.
Remove the stale entries so every TOC link resolves again.

Signed-off-by: ump45nose <1729065730@qq.com>
@ump45nose
ump45nose requested review from a team as code owners October 5, 2026 04:06
@vercel

vercel Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
nodejs-org Ready Ready Preview Oct 5, 2026 4:07am UTC

Request Review

This branch was successfully deployed

1 active deployment
Preview — 4d5d2a52 Deployed Oct 5, 2026 by vercel[bot]
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