Skip to content

docs(links): update README to reflect current link checkers - #45511

Closed
MeGaurav4 wants to merge 1 commit into
github:mainfrom
MeGaurav4:fix/45508-stale-link-checker-docs
Closed

docs(links): update README to reflect current link checkers#45511
MeGaurav4 wants to merge 1 commit into
github:mainfrom
MeGaurav4:fix/45508-stale-link-checker-docs

Conversation

@MeGaurav4

Copy link
Copy Markdown

Closes #45508

What?

Updated src/links/README.md to match the current link-checking system:

  • Replaced the removed rendered-content-link-checker.ts script and the
    unavailable rendered-content-link-checker-cli npm command with the current
    check-links-pr, check-links-internal, and check-links-external scripts.
  • Removed the obsolete --level and --check-external-links options and
    documented the real options (--files, --version/--language, --max).
  • Added the components/ path to the LinkPreviewPopover.tsx reference.
  • Updated the stale performance note that still named the removed checker.

Why?

The issue reporter noticed the README still describes the previous
rendered-content link checker while working on #45507. The deleted script and
command no longer exist, so the docs were misleading.

Checks

  • No rendered-content-link-checker references remain (grep verified)
  • All documented scripts/commands verified against src/links/scripts and package.json

The rendered-content-link-checker.ts script and its rendered-content-link-checker-cli
npm command were removed when the link-checking system was rebuilt, but
src/links/README.md still documented them, including obsolete options
(--level, --check-external-links).

Replace them with the current checkers (check-links-pr, check-links-internal,
check-links-external), document their options, add the components/ path to the
LinkPreviewPopover.tsx reference, and update the stale performance note.

Signed-off-by: MeGaurav4 <gaurav3.141592@gmail.com>
@github-actions

Copy link
Copy Markdown
Contributor

👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions:

  • src/links/README.md

You'll need to revert all of the files you changed that match that list using GitHub Desktop or git checkout origin/main <file name>. Once you get those files reverted, we can continue with the review process. :octocat:

The complete list of files we can't accept are:

  • .devcontainer/**
  • .github/**
  • data/reusables/rai/**
  • Dockerfile*
  • src/**
  • package*.json
  • content/actions/how-tos/security-for-github-actions/security-hardening-your-deployments/**

We also can't accept contributions to files in the content directory with frontmatter contentType: rai.

@github-actions

Copy link
Copy Markdown
Contributor

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

This pull request contains code changes, so we will not generate a table of review links.

🤖 This comment is automatically generated.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Aug 16, 2026
@MeGaurav4

Copy link
Copy Markdown
Author

Closing: the triage check (check-unallowed-file-changes) blocks all external contributions touching src/** (see src/workflows/unallowed-contribution-filters.yml). This change can only land from the internal repository. The issue reporter noted this while working internally on #45507, so leaving the fix to the docs team. Thanks for flagging #45508.

@MeGaurav4 MeGaurav4 closed this Aug 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

triage Do not begin working on this issue until triaged by the team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

internal: Update stale link checker documentation

1 participant