Add user guide and adoption-helpful README signposts#48
Merged
Conversation
114a004 to
c3014b4
Compare
ffe56f7 to
69bea69
Compare
c3014b4 to
d980e7d
Compare
69bea69 to
1dff769
Compare
d980e7d to
8cee641
Compare
1dff769 to
7095451
Compare
8cee641 to
968ed2b
Compare
7095451 to
484cf3a
Compare
968ed2b to
c8e2172
Compare
484cf3a to
b2b499e
Compare
c8e2172 to
4a94693
Compare
b2b499e to
a2c412a
Compare
20b1678 to
86022da
Compare
86022da to
242d01c
Compare
docs/guide.md is the long-form companion to the crate README, covering installation, code generation, server and client usage, streaming, tower middleware, hosting, TLS, errors, and compression. The guide references the streaming-tour and middleware examples as canonical patterns and delegates protocol-specific detail to the existing examples READMEs. README updates: - Adds a Status / MSRV / Documentation block near the top, pointing readers at the guide, examples directory, and docs.rs. - Adds a Streaming, middleware, TLS subsection at the end of Quick Start with focused links into the guide and examples for each.
242d01c to
4788a7f
Compare
asacamano
approved these changes
Apr 5, 2026
asacamano
left a comment
There was a problem hiding this comment.
This is so awesome! Just reading over it I was think "yes, this is exactly what it should be like."
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Closes #47
Adds `docs/guide.md` as the long-form companion to the crate README, plus README updates that surface the guide and the examples directory near the top.
Stacked on #46 - this PR's base is `feat/examples-streaming-middleware` because the guide and README reference `examples/streaming-tour/` and `examples/middleware/` from #46. Once #46 merges, GitHub will rebase this onto main automatically (or I'll do it manually).
docs/guide.md
801 lines covering:
The guide references the streaming-tour and middleware examples (PR #46) for runnable patterns rather than duplicating handler code inline. Each section is self-contained enough to land via search or external link.
README updates
19 line diff to README; everything else stays as it was.
Merge dependencies