-
Notifications
You must be signed in to change notification settings - Fork 3.9k
Open
Labels
Milestone
Description
Some people (even seasoned developers) get thrown off by our documentation, let's try to fix that!
- Add descriptions of what each funcion does, aside from linking the man page
- Add an example for each handle at the top of its file, and for the individual function after their description
- Add a "getting started" section
- Document parameters and possible return values for all functions (the UDP docs are a good example though it can still be improved further)
- Evaluate our relationship with the uvbook: see if we can collaborate somehow, in case we want to add parts of it to our docs
- Find a Sphinx theme (or adapt an existing one) to be mobile friendly: [website] Use a responsive Sphinx theme #801
- Add some more examples: a simple HTTP client which sends "hello" using http_parser, a "micro netcat", (other suggestions are welcome)
This is an ongoing effort, those who want to contribute to it are welcome to do so, please leave a note here so we know who is working on what. Modifying each handle separately is probably the best, to be gin with, and the individual functions in batches.
Reactions are currently unavailable