diff options
| author | binarycat <binarycat@envs.net> | 2025-08-08 14:26:01 -0500 |
|---|---|---|
| committer | binarycat <binarycat@envs.net> | 2025-08-09 12:27:19 -0500 |
| commit | a59842e4d5ba8424996d25f95da67d912ffbb333 (patch) | |
| tree | 1a7b5b9db872e288f55712852cc53eab46a1ba8e | |
| parent | 213d946a384b46989f6fd9c8ae9c547b4e354455 (diff) | |
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
| -rw-r--r-- | .github/ISSUE_TEMPLATE/documentation.yaml | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/.github/ISSUE_TEMPLATE/documentation.yaml b/.github/ISSUE_TEMPLATE/documentation.yaml index 712b32759ae..4a79cd4ba97 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yaml +++ b/.github/ISSUE_TEMPLATE/documentation.yaml @@ -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 \ No newline at end of file + required: true |