Open gavv opened 9 months ago
We have two major pages documenting our C API:
Reference provides a detailed description of every type and function. Examples provide complete C programs demonstrating API usage.
It would be nice to add another page: tutorial / guide style introduction to the API, providing step-by-step instructions.
Here is a good example of what I mean: https://github.com/google/oboe/blob/main/docs/FullGuide.md
The tutorial should provide code snippets for every step and also explain various configuration options. Mostly, it will not provide any new information, just the same what is already available in reference and examples, but in another form.
The new page should be added here:
This page provides info on how to build documentation locally: https://roc-streaming.org/toolkit/docs/building/developer_cookbook.html
We have two major pages documenting our C API:
Reference provides a detailed description of every type and function. Examples provide complete C programs demonstrating API usage.
It would be nice to add another page: tutorial / guide style introduction to the API, providing step-by-step instructions.
Here is a good example of what I mean: https://github.com/google/oboe/blob/main/docs/FullGuide.md
The tutorial should provide code snippets for every step and also explain various configuration options. Mostly, it will not provide any new information, just the same what is already available in reference and examples, but in another form.
The new page should be added here:
This page provides info on how to build documentation locally: https://roc-streaming.org/toolkit/docs/building/developer_cookbook.html