Ensure consistency and clarity in documentation for both public API and private API #7
Description
The following is required to understand the motivation behind this project and why it is useful.
- Learn and understand the basics of concurrency vs parallelism, the strenghts & weaknesses of both and the benefit of combining both on modern computers, and how coroutines are common approaches to implement asynchronous programming
- Read the blog posts in here to understand the machinery done by compilers in C++ 20 to support coroutines: (note that you can look into other sources as well if you think this is too complicated)
- Look at cpp-async, stdexec, folly, cppcoro, libcoro, etc and how they create the boilerplate libraries for their coroutine implementations
- Look into the following: Windows IOCP, Linux io_uring, Linux epoll, MacOS (and other BSD platforms) kqueue and how they manage asynchronous IO at the native level
- Read through the different classes in the repo, try to understand whats going on (making diagrams is encouraged)
- Update the comments, readme's, and diagrams for consistency and Add comments and documentation where lacking