Open seanmonstar opened 1 year ago
Hi, maybe it would be useful to mention the repository https://github.com/hyperium/hyperium.github.io, for the sake of future contributors who come to this issue looking to contribute to the documentation.
@A248 Ah, what I meant by "API docs" is those that are within the source code here, that get rendered at docs.rs/hyper. The website repository is the subject of #3068.
I'm going through the currently rendered docs (of rc4) and writing down some notes in the top comment about what needs to be improved. By making them separate items in a task list, it should be easy to convert any single one into an issue. If you'd like to fix any, start a pull request mentioning it, and I'll click the button to convert the task into an issue.
An item tagged with 👀 means I haven't yet analyzed the module or its types.
This is issue about what appears at https://docs.rs/hyper. As a general rule, we should incrementally improve them with the following in mind:
Items to document
conn
: 👀Protocol
: explain that it is for http/2, what it does, that it must be used with associated builder options, show exampleReasonPhrase
unstable
tagconn
module: mention hyper-util providing anAutoConnection
and builderconn::http1
module: provide an overview, and a getting started sectionconn::http1::Builder
: Provide an example constructing one and setting some options.conn::http1::Connection
: Explain that this is returned fromBuilder::serve_connection
, and that it is essential animpl Future
that must be polled (orawait
ed) for anything to happen.conn::http2
module: provide an overview, and a getting started section