fix(doc): Fix broken links to zebra_network
and zebra_state
Config
structs on doc.zebra.zfnd.org
#7838
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.
Motivation
What are the most important goals of the ticket or PR?
This PR fixes broken links to the
zebra_network
andzebra_state
Config
structs in https://doc.zebra.zfnd.org/zebrad/config/struct.ZebradConfig.htmlClose #7048
PR Author Checklist
Check before marking the PR as ready for review:
Does it need extra CHANGELOG info?Have you added or updated tests?Is the documentation up to date?This PR doesn't change Rust code behaviour, just the generated doc links.
Solution
Related:
zebra-test
from the external docs buildTesting
I manually tested this locally with the doc build command we use in CI, and checked the files for
zebra_network/zebra_network
andzebra_state/zebra_state
.Review
This is a routine fix.
The generated docs from this PR should be checked for broken links in https://doc.zebra.zfnd.org/zebrad/config/struct.ZebradConfig.html
The "Deploy external docs to firebase" step logs a preview URL with the docs from each PR.
Reviewer Checklist
Check before approving the PR:
And check the PR Author checklist is complete.
Follow Up Work
If this happens again we should just link to docs.rs, it doesn't have this bug: