1.6 KiB
1.6 KiB
| name | about | labels |
|---|---|---|
| Documentation 📝 | Suggest better docs coverage for a particular tool or process. | suggestion-docs |
Summary
What problem(s) did you run into that caused you to request additional documentation? What questions do you think we should answer? What, if any, existing documentation relates to this proposal?
Some recommended topics to cover:
- List the topics you think should be here.
- This list does not need to be exhaustive!
Motivation
Why should we document this and who will benefit from it?
Steps to resolve this issue
Draft the doc
- Write the doc, following the format listed in these resources:
- Overview on contributing module documentation
- Docs Templates
- Example of a similar article
Open a pull request
- Open a pull request with your work including the words "closes #[this issue's number]" in the pull request description