documentation_template.md 826 bytes
name: Documentation improvement
about: Propose a change or an update to the documentation
title: ""
labels: documentation
assignees: ""

Report type

  • Missing documentation
  • Fix current documentation (errors)

What is the URL of the documentation (if applicable)?

What can be improved?
A clear and concise description of what can be improved. Examples:

  • "I don't understand where the ${XYZ} variable is set."
  • "There seems to be a step missing between 'X' and 'Z'. I don't know how to get to 'Z'."
  • "When I run command sub-command ... I get the following error:"
  • "I don't know what is meant by 'gerble barb gazoink` in the instructions".

Suggested text
Detail proposed changes to update the documentation if you have any.