Documentation issue template
============================

.. code-block:: markdown

    ---
    name: Documentation improvement
    about: Request a documentation improvement
    title: ''
    labels: ''
    assignees: ''
    ---

    **Describe the flaw**
    A clear description of what the error or weakness in the documentation is.

    **Suggest an improvement**
    A clear description of what you want to change or add to the documentation.

    **Supporting materials**
    If applicable, add links or screenshots to help explain the flaw.

    **Desktop/Environment**
    If applicable, please specify the environment this is relevant for (e.g. "documentation regarding MacOS" or "does not render in Firefox").

    **Additional context**
    Add any other context about the documentation flaw here.


Links to resources
------------------

* `Create issue templates on GitHub <https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository>`_
* `Create issue templates on GitLab <https://docs.gitlab.com/ee/user/project/description_templates.html>`_