Skip to content

Link to the user guide from the crate docs #1017

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Shubham-Padkonde wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Link to the user guide from the crate docs #1017

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions pingora-proxy/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@
//! run it.
//!
//! See `examples/load_balancer.rs` for a detailed example.
//!
//! For an introduction to this crate's interfaces and the stages of a request, see the
//! [user guide](https://github.com/cloudflare/pingora/blob/main/docs/user_guide/index.md).

use async_trait::async_trait;
use bytes::Bytes;
Expand Down
3 changes: 3 additions & 0 deletions pingora/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@
//!
//! If looking to build a (reverse) proxy, see [`pingora-proxy`](https://docs.rs/pingora-proxy) crate.
//!
//! The [user guide](https://github.com/cloudflare/pingora/blob/main/docs/user_guide/index.md) introduces
//! both crates and walks through building a proxy with them.
//!
//! # Feature flags
#![cfg_attr(
feature = "document-features",
Expand Down
Loading