Skip to content

Conversation

@stevhliu
Copy link
Member

@stevhliu stevhliu commented Oct 8, 2025

Adds a link checker to the doc-builder command with 2 view options:

  1. more detailed view highlighting the broken text and link
uv run doc-builder check-links /path/to/docs
Screenshot 2025-10-08 at 3 18 41 PM
  1. more compact view
uv run doc-builder check-links /path/to/docs --format link
Screenshot 2025-10-08 at 3 17 59 PM

@stevhliu stevhliu requested a review from mishig25 October 8, 2025 22:45
@mishig25
Copy link
Contributor

mishig25 commented Oct 9, 2025

Looks great! I can merge it once you solve the failing test cases

@stevhliu
Copy link
Member Author

stevhliu commented Oct 9, 2025

Tests are passing now, let me know if there is anything else!

@mishig25 mishig25 merged commit d4f9e10 into huggingface:main Oct 9, 2025
4 checks passed
@mishig25
Copy link
Contributor

mishig25 commented Oct 9, 2025

amazing! Actually I realize that the failing tests werent even related to your PR, thanks for fixing them 👍

@stevhliu stevhliu deleted the link-checker branch October 9, 2025 18:52
@mishig25
Copy link
Contributor

mishig25 commented Oct 9, 2025

btw, feel free to document uv run doc-builder check-links /path/to/docs in the README

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants