improve "Documentation problem" issue template.
rustdoc has its own issue template now, mention that. swap the order of the last two sentances so it reads more like a typical if/else chain (base case listed last). adjust some labels and descriptions
This commit is contained in:
parent
213d946a38
commit
a59842e4d5
1 changed files with 6 additions and 6 deletions
12
.github/ISSUE_TEMPLATE/documentation.yaml
vendored
12
.github/ISSUE_TEMPLATE/documentation.yaml
vendored
|
|
@ -1,5 +1,5 @@
|
|||
name: Documentation problem
|
||||
description: Create a report for a documentation problem.
|
||||
description: Report an issue with documentation content.
|
||||
labels: ["A-docs"]
|
||||
body:
|
||||
- type: markdown
|
||||
|
|
@ -19,20 +19,20 @@ body:
|
|||
- [The Rustonomicon](https://github.com/rust-lang/nomicon/issues)
|
||||
- [The Embedded Book](https://github.com/rust-embedded/book/issues)
|
||||
|
||||
All other documentation issues should be filed here.
|
||||
Or, if you find an issue related to rustdoc (e.g. doctest, rustdoc UI), please use the rustdoc issue template instead.
|
||||
|
||||
Or, if you find an issue related to rustdoc (e.g. doctest, rustdoc UI), please use the bug report or blank issue template instead.
|
||||
All other documentation issues should be filed here.
|
||||
|
||||
- type: textarea
|
||||
id: location
|
||||
attributes:
|
||||
label: Location
|
||||
label: Location (URL)
|
||||
validations:
|
||||
required: true
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: summary
|
||||
attributes:
|
||||
label: Summary
|
||||
validations:
|
||||
required: true
|
||||
required: true
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue