How to build a Recipe
This chapter demonstrates the standard layout and features available for cookbook entries. Make sure to visit the website to see how the documentation is rendered and to get a better sense of how to structure your recipe. You can use the template recipe as a starting point.
This cookbook is built using Verso, hence understanding how to write in Verso is essential. Please go through this page to get familiar with writing styled documentation in Verso. You can also refer other recipes for the same or checkout the Verso Manual for more detailed information.
A typical recipe should have the following structure:
-
A simple readable title that clearly indicates the problem being solved.
-
An introduction that gives a brief overview of the problem and the solution.
-
A code snippet that demonstrates the solution.
-
Any explanation required or referencing other resources for further reading.
-
Any more follow up usecases of this solution in a subsection, for example, for reading a file, you can also mention on how to read a JSON, CSV, etc. filetypes. No need for another recipe for each filetype. Please do add Tags and Index to each of the subheader for easy referencing.
-
Please do mention any other debugging tips, expected errors, further usage of the solution, etc.
You can find this template in the repository here.