A template for reporting documentation bugs in GHC-bundled libraries
Motivation
The current templates available for filing bugs are very compiler-and-programming-oriented. This is great for those cases (which are by far the most common), but documentation bugs are also important. When I went to file a documentation-related bug just a few minutes ago, I only had the choice between a 'bug' template (which is intended for things that aren't to do with documentation) or a 'feature request' template (which that issue was not). This choice creates odd mismatches between the information I want to convey and what the template(s) wants me to include - I am fairly sure nobody needs to know my GHC version if the bug is documentation-related (especially if said documentation is hosted online).
Proposal
A dedicated template for reporting documentation bugs should exist. It should probably contain the following headings/fields:
- Location of the documentation of issue
- What is not good about this documentation? (incorrect, misleading, badly-spelled, etc.)
- Proposed correction(s)