Repository navigation
Description
To contributors: this change can only be done by internal Github maintainers. Any PR is automatically closed.
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
While working on #45507, I noticed that src/links/README.md still describes the previous rendered-content link checker.
The old rendered-content-link-checker.ts and rendered-content-link-checker-cli.ts scripts were removed when the link-checking system was rebuilt. However, the README still:
- References the deleted
rendered-content-link-checker.tsscript. - Recommends running the unavailable
rendered-content-link-checker-clinpm command. - Documents obsolete options such as
--leveland--check-external-links. - Lists
LinkPreviewPopover.tsxwithout its currentcomponents/path.
The current link-checking commands are:
npm run check-links-prnpm run check-links-internalnpm run check-links-external
What changes are you suggesting?
Update the README’s architecture, usage examples, supported options, component path, and performance notes to reflect the current link-checking system.
This should be a documentation-only change. I closed #45507 so the gap could be discussed and confirmed before proposing another update.
I may be missing context about how this internal README is intended to be maintained, so I’d appreciate confirmation that bringing it in line with the current scripts would be useful.
Additional information
No response
Activity
[-]Update stale link checker documentation[/-][+]internal: Update stale link checker documentation[/+]subatoi commentedon Aug 17, 2026
Hi @raulkolaric, many thanks for bringing this to our attention—
I'll bring this to the attention of the relevant Engineering team as this is certainly something we'd need to fix internally.
docs-bot commentedon Aug 17, 2026
Thank you for opening this issue! Updates to this documentation must be made internally. I have copied your issue to an internal issue, so I will close this issue.
subatoi commentedon Aug 18, 2026
Hi @raulkolaric, I just wanted to follow up that an internal fix will ship for this shortly. Thank you again for reporting it, and for your interest in the GitHub docs 🙇
raulkolaric commentedon Aug 18, 2026
@subatoi Glad to hear it! Thanks for the follow-up, and happy I could help!