about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJakub Beránek <berykubik@gmail.com>2025-06-20 20:03:22 +0200
committerGitHub <noreply@github.com>2025-06-20 20:03:22 +0200
commitabe7991bb4109de388f1dffccfc9e1f3a54a970c (patch)
tree4d028d572ab4f0760ba3542573bbb167bc8f7a68
parent6c58f693ccb190c9adf6e3f367b885a819b2efb6 (diff)
parentdfaa6220e22cfed43ea36d958d239c67896a9ceb (diff)
downloadrust-abe7991bb4109de388f1dffccfc9e1f3a54a970c.tar.gz
rust-abe7991bb4109de388f1dffccfc9e1f3a54a970c.zip
Rollup merge of #142736 - lolbinarycat:rustdoc-issue-template, r=GuillaumeGomez,fmease
add issue template for rustdoc

~~This also expands the scope of the "diagnostic
issue" template to include rustdoc lints,
meaning diagnostic issues will need triaging again. I think this is preferable to the alternative of
cramming even more cases under a single issue template.~~

r? t-rustdoc
-rw-r--r--.github/ISSUE_TEMPLATE/rustdoc.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/rustdoc.md b/.github/ISSUE_TEMPLATE/rustdoc.md
new file mode 100644
index 00000000000..130d5f67102
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/rustdoc.md
@@ -0,0 +1,54 @@
+---
+name: Problem with rustdoc
+about: Report an issue with how docs get generated.
+labels: C-bug, T-rustdoc
+---
+<!--
+Thank you for filing a rustdoc issue! Rustdoc is the tool that handles the generation of docs.  It is usually invoked via `cargo doc`, but can also be used directly.
+
+If you have an issue with the actual content of the docs, use the "Documentation problem" template instead.
+-->
+
+# Code
+<!-- problematic snippet and/or link to repo and/or full path of standard library function -->
+
+```rust
+<code>
+```
+
+# Reproduction Steps
+<!--
+* command(s) to run, if any
+* permalink to hosted documentation, if any
+* search query, if any
+-->
+
+# Expected Outcome
+<!--
+What did you want to happen?
+
+For GUI issues, feel free to provide a mockup image of what you want it to look like.
+
+For diagnostics, please provide a mockup of the desired output in a code block.
+-->
+
+# Actual Output
+<!--
+* rustdoc console output
+* browser screenshot of generated html
+* rustdoc json (prettify by running through `jq` or running thorugh an online formatter)
+-->
+```console
+<code>
+```
+
+
+# Version
+<!--
+Available via `rustdoc --version` or under the "Help" menu.
+
+If the issue involves opening the documentation in a browser, please also provide the name and version of the browser used.
+-->
+
+# Additional Details
+<!-- Anything else you think is relevant -->