Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generation of documentation #103

Open
palmskog opened this issue Oct 17, 2019 · 0 comments
Open

Generation of documentation #103

palmskog opened this issue Oct 17, 2019 · 0 comments

Comments

@palmskog
Copy link
Collaborator

palmskog commented Oct 17, 2019

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant