name | about | title | labels | assignees |
---|---|---|---|---|
Documentation request |
Suggest an improvement of the documentation. |
docs: Add content spec section (keep short, use imperative mood) |
documentation |
- I did all of the following:
- consider getting feedback on the idea in the discussions
- search for duplicate or closed issues
- read the documentation request contribution guidelines
Feel free to treat this template as guidance and deviate where necessary.
Present the desired benefit to users and how to improve the documentation to get there.
[Optional] Add more details on the motivation for this improvement.
What is the expected outcome? What use cases does it support? Why are we doing this? Why would this enhancement be useful to most users?
[Optional] Break down the suggested amendment in smaller parts.
[Optional] A clear and concise description of alternative solutions considered.
[Optional] Add any other context or screenshots about the documentation request.