refine documentation

[Xudong-Huang]

there are a lot of work need to about the documentation.

[akritrime]

Hey. How may I help? I am a beginner, but I was wondering what I can do to help.

[Xudong-Huang]

@akritrime Thanks！Currently the doc is too far from complete. The most obvious and easy task is add document for every API that compatible with libstd . Add corresponding links to libstd document, or add examples in the document.

[akritrime]

Alright. So you want me to add documentation for May counterparts for libstd api like std::net::TcpStream and the likes?

[Xudong-Huang]

Yes, that would be much helpful for new users. Thanks!

[akritrime]

All the networking primitives provided in may::net are non blocking, right?

[Xudong-Huang]

well, it's depends... if you call the API in thread context, all the APIs are thread blocked version, while called in coroutine context, they are coroutine blocked version but never block the thread(non blocking mode in normal sense)