Skip to content

Help writing documentation #18

Description

@epsilon-0

Feature: Well written, clear and formatted documentation.

Recommended approaches
Currently, Most of the configuration files and yml files have well put variable names and functionality. Unfortunately, explaining each choice and option has not been done well enough and what has been written, is written by a mathematics researcher with her very little experience in writing nicely formatted documents.

Any help in formatting, restructuring sentences and paragraphs, improving the language would be really highly appreciated.

Documentation pull requests will be given the highest priority, other than highly vulnerable security fixes.

Additional Information
If any of the documentation is lacking you can also open a bug on github to ask for answers. These can be used to improve documentation and can be added to a pull request.

Volunteers to help improve documentation are the most valuable. You all have no idea how important you are to the community :)

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or requesthelp wantedExtra attention is needed

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions