Many kinds of documentation of a project like this are useful. Here is an attempt to break down different kinds of documentation and provide hints about how they can be generated:
- Project metadata, including short descriptions of what the project is about (1 sentence, 1 paragraph, ...)
see example from the Coq community
- Changelog summarizing how the project has evolved, for example using the Keep a Changelog format
see example from the Coq community
- Learning resources, such as listing of examples and step-by-step tutorials
see example from the Coq community
- Website which organizes and contains the all of the above, preferably mostly auto-generated
see example from the Coq community
This issue is connected to #102, since releases usually deserve special documentation.
Many kinds of documentation of a project like this are useful. Here is an attempt to break down different kinds of documentation and provide hints about how they can be generated:
see example from the Coq community
see example from the Coq community
see example from the Coq community
see example from the Coq community
This issue is connected to #102, since releases usually deserve special documentation.