Skip to content

internal: Update stale link checker documentation #45508

Closed

Description

@raulkolaric

To contributors: this change can only be done by internal Github maintainers. Any PR is automatically closed.

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.ts script.
  • Recommends running the unavailable rendered-content-link-checker-cli npm command.
  • Documents obsolete options such as --level and --check-external-links.
  • Lists LinkPreviewPopover.tsx without its current components/ path.

The current link-checking commands are:

  • npm run check-links-pr
  • npm run check-links-internal
  • npm 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

  1. added
    contentThis issue or pull request belongs to the Docs Content team
    on Aug 15, 2026
  2. added
    triageDo not begin working on this issue until triaged by the team
    on Aug 15, 2026
  3. changed the title [-]Update stale link checker documentation[/-] [+]internal: Update stale link checker documentation[/+] on Aug 16, 2026
  4. subatoi commented on Aug 17, 2026

    @subatoi
    Contributor

    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.

  5. added
    fix-internallyTriggers a workflow to copy the issue internally and close the current issue
    on Aug 17, 2026
  6. docs-bot commented on Aug 17, 2026

    @docs-bot
    Collaborator

    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.

  7. subatoi commented on Aug 18, 2026

    @subatoi
    Contributor

    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 🙇

  8. raulkolaric commented on Aug 18, 2026

    @raulkolaric
    ContributorAuthor

    @subatoi Glad to hear it! Thanks for the follow-up, and happy I could help!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamfix-internallyTriggers a workflow to copy the issue internally and close the current issuetriageDo not begin working on this issue until triaged by the team

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions