about summary refs log tree commit diff
diff options
context:
space:
mode:
authorStuart Cook <Zalathar@users.noreply.github.com>2025-08-10 19:45:51 +1000
committerGitHub <noreply@github.com>2025-08-10 19:45:51 +1000
commit7b3afa65540e13deb346d7a0b34b30bd43eec46b (patch)
tree83881fc5e6352e0190be4e7bdc65cc2d8b8579e3
parent2e0829173be009c58b05cb8bbda4d223cae4cdc9 (diff)
parenta59842e4d5ba8424996d25f95da67d912ffbb333 (diff)
downloadrust-7b3afa65540e13deb346d7a0b34b30bd43eec46b.tar.gz
rust-7b3afa65540e13deb346d7a0b34b30bd43eec46b.zip
Rollup merge of #145130 - lolbinarycat:issue-template-docs-update, r=Noratrieb
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).
-rw-r--r--.github/ISSUE_TEMPLATE/documentation.yaml12
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