change(docs): Point to a manually created list of Zebra crates in docs #8160
Conversation
This file contains 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
PR #7886 introduced this link to docs.rs for the docs of the public APIs: https://docs.rs/releases/search?query=zebra. However, the query in the link returns crates that are not part of the Zebra's public API, and doesn't return the two tower-* crates that are part of Zebra. This commit refers to a manually created list of links pointing to the docs of the public APIs of all current Zebra crates.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
PR #7886 introduced this link to docs.rs for the docs of the public APIs: https://docs.rs/releases/search?query=zebra. However, the query in the link returns crates that are not part of the Zebra's public API and doesn't return the two tower-* crates that are part of Zebra.
This is a regular clean-up.
PR Author Checklist
Check before marking the PR as ready for review:
For significant changes:
If a checkbox isn't relevant to the PR, mark it as done.
Solution
This PR refers to a manually created list of links pointing to the docs of the public APIs of all current Zebra crates.
Reviewer Checklist
Check before approving the PR:
PR blockers can be dealt with in new tickets or PRs.
And check the PR Author checklist is complete.