Link to the user guide from the crate docs - #1017
Open
Shubham-Padkonde wants to merge 1 commit into
Open
Shubham-Padkonde wants to merge 1 commit into
Shubham-Padkonde wants to merge 1 commit into
Conversation
The user guide is only discoverable from the repository, so someone reading the crates on docs.rs can work with pingora for weeks without finding it. Link to it from the two crates a user starts at. Fixes cloudflare#1015 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
1 participant
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.
Fixes #1015
The user guide lives in the repository, so someone who finds pingora through docs.rs — as the reporter did — can build a proxy without ever learning it exists.
This adds a link to it from the two crates a user starts at:
pingora-proxy, right after the "How to use" section, which is where the reporter suggested it;pingora, next to the existing pointer topingora-proxy.Both are absolute links to
docs/user_guide/index.mdonmain, so they resolve from docs.rs as well as from the repository.cargo doc -p pingora-proxy --no-depsbuilds with no new warnings, andcargo fmt --checkis clean.Disclosure: this change was written by Claude Code (Claude Opus 5) working as my agent, at my direction. I am accountable for what is submitted here and will follow up on review feedback.
🤖 Generated with Claude Code