boostorg / boostorg/beast

Proper Documentation on http::request and http::response

Open
#2,214 12 comments 0 reactions 1 assignee Claimed by @madmongo1 View on GitHub
Doc
Dominant language
C++
Stars
4.8k
Forks
694
Avg merge
12h 48m
Merged PRs (30d)
1

Description

In boost Beast documentation nowhere mentioning how to properly create the Request and Response object.
Boost Beast Reference page is missing some basic things, So, I have to watch all your great talk to make me motivated to use Beast even if these are too great and knowledgeable, can't cover all the Beast features. I really like how fast you try to cover the content in a limited time.

As for reference, these are the reference page for the Response, Request class, and file_body class.
https://www.boost.org/doc/libs/1_68_0/libs/beast/doc/html/beast/ref/boost__beast__http__request.html
https://www.boost.org/doc/libs/1_68_0/libs/beast/doc/html/beast/ref/boost__beast__http__response.html
https://www.boost.org/doc/libs/1_68_0/libs/beast/doc/html/beast/ref/boost__beast__http__file_body.html

**There should be some example at the end of all references, So People get to know how to use them.**
I know it's time-consuming but please cover at least basic concepts So, New people like me at least know how to use basic functionality. I have read example Its great still haven't mentioned how to create request and response object.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.