docs(links): update README to reflect current link checkers - #45511
docs(links): update README to reflect current link checkers#45511MeGaurav4 wants to merge 1 commit into
Conversation
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>
|
👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions:
You'll need to revert all of the files you changed that match that list using GitHub Desktop or The complete list of files we can't accept are:
We also can't accept contributions to files in the content directory with frontmatter |
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 linksNote: 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. |
|
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. |
Closes #45508
What?
Updated src/links/README.md to match the current link-checking system:
rendered-content-link-checker.tsscript and theunavailable
rendered-content-link-checker-clinpm command with the currentcheck-links-pr,check-links-internal, andcheck-links-externalscripts.--leveland--check-external-linksoptions anddocumented the real options (
--files,--version/--language,--max).components/path to theLinkPreviewPopover.tsxreference.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