Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.35 KB

documentation_request.md

File metadata and controls

41 lines (29 loc) · 1.35 KB
name about title labels assignees
Documentation request
Suggest an improvement of the documentation.
docs: Add content spec section (keep short, use imperative mood)
documentation

Feel free to treat this template as guidance and deviate where necessary.

Summary

Present the desired benefit to users and how to improve the documentation to get there.

Motivation

[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?

Outline

[Optional] Break down the suggested amendment in smaller parts.

Describe alternatives you've considered

[Optional] A clear and concise description of alternative solutions considered.

Additional context

[Optional] Add any other context or screenshots about the documentation request.