Skip to content

docs: fix broken README link in rb_test docstring for Bazel registry#386

Merged
p0deje merged 2 commits into
bazel-contrib:mainfrom
georgesfarah:fix/broken-registry-doc-link
Jul 21, 2026
Merged

docs: fix broken README link in rb_test docstring for Bazel registry#386
p0deje merged 2 commits into
bazel-contrib:mainfrom
georgesfarah:fix/broken-registry-doc-link

Conversation

@georgesfarah

Copy link
Copy Markdown
Contributor

Summary

  • The rb_test docstring links to ../../README.md#code-coverage, which is a relative file path that works on GitHub but breaks on the Bazel registry (registry.bazel.build), where it resolves to a 404.
  • Replaced with an absolute GitHub URL so the link works on both GitHub and the registry.

You can see the broken link here: https://registry.bazel.build/docs/rules_ruby (in the rb_test > Code Coverage section)

Test plan

Manual testing:

  1. Visit https://registry.bazel.build/docs/rules_ruby
  2. Find the rb_test rule documentation, scroll to the "Code Coverage" section
  3. Click the "README" link — currently leads to a 404
  4. After this fix, the link will point to https://github.com/bazel-contrib/rules_ruby/blob/main/README.md#code-coverage

The Bazel registry (registry.bazel.build) renders rule docstrings as
HTML. The relative path `../../README.md#code-coverage` resolves against
registry.bazel.build instead of the GitHub repo, resulting in a 404.

Replace with an absolute GitHub URL so the link works correctly on both
GitHub and the registry.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@p0deje
p0deje merged commit c47520c into bazel-contrib:main Jul 21, 2026
56 checks passed
@p0deje

p0deje commented Jul 21, 2026

Copy link
Copy Markdown
Member

Thank you!

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