[skip changelog] Add link check exclusions for broken generated Protocol Buffer doc links#3221
Merged
Merged
Conversation
per1234
added
topic: documentation
|
|
…col Buffer doc links Documentation of the Protocol Buffers interface is automatically generated from the project source code. Unfortunately the documentation generator produces some broken links. These cause the project infrastructure's link checker to fail: ``` ERROR: 104 dead links found in ./docs/rpc/commands.md ! [✖] #google-protobuf-Any → Status: 404 [✖] #google-rpc-Status → Status: 404 ``` It will not be feasible to fix these links, so the only available resolution for those link check failures is to configure exclusions.
per1234
force-pushed
the
proto-doc-exclude
branch
from
eca2e3d to
4041ee6
Compare
cmaglie
approved these changes
Jun 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)configuration.schema.jsonupdated if new parameters are added.What kind of change does this PR introduce?
Bug fix
What is the current behavior?
Documentation of the Protocol Buffers interface is automatically generated from the project source code.
Unfortunately the documentation generator produces some broken links. These cause the project infrastructure's link checker to fail:
What is the new behavior?
It will not be feasible to fix these links, so the only available resolution for those link check failures is to configure exclusions.
Does this PR introduce a breaking change, and is titled accordingly?
No breaking change.