Skip to content

docs(links): update link checker README - #45507

Closed
raulkolaric wants to merge 1 commit into
github:mainfrom
raulkolaric:links-readme-refresh
Closed

docs(links): update link checker README#45507
raulkolaric wants to merge 1 commit into
github:mainfrom
raulkolaric:links-readme-refresh

Conversation

@raulkolaric

@raulkolaric raulkolaric commented Aug 15, 2026

Copy link
Copy Markdown
Contributor

Summary

This is a small documentation follow-up to the link-checker rebuild synced in #42569 (commit 7abf80d211). That change replaced the rendered-content link checker with separate PR, internal, and external link-checking commands, but src/links/README.md continued to describe the deleted tooling.

Changes

  • Replace references to the deleted rendered-content-link-checker scripts.
  • Document the current link-checking commands:
    • check-links-pr
    • check-links-internal
    • check-links-external
  • Add examples using the supported CLI options.
  • Correct the path to components/LinkPreviewPopover.tsx.
  • Update the performance note to reflect the split between internal rendering and external-link caching.

Validation

  • git diff --check
  • npm run check-links-pr -- --help
  • npm run check-links-internal -- --help
  • npm run check-links-external -- --help

I kept this change limited to the module README. Please let me know if any of the usage guidance would be clearer with different examples or terminology.

@raulkolaric
docs(links): update link checker README
3978f76 
Replace references to the deleted rendered-content link checker with the current PR, internal, and external checkers. Correct the component path and describe the current performance behavior.

Changes:
- src/links/README.md
  - Document the current link checker scripts, examples, and supported CLI options.
  - Correct the LinkPreviewPopover path and remove obsolete checker details.

Validation:
- git diff --staged --check
- npm run check-links-pr -- --help
- npm run check-links-internal -- --help
- npm run check-links-external -- --help
@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Aug 15, 2026
@github-actions

github-actions Bot commented Aug 15, 2026

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

github-actions Bot commented Aug 15, 2026

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.

@raulkolaric raulkolaric mentioned this pull request Aug 15, 2026
Open
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@raulkolaric