about summary refs log tree commit diff
path: root/.github
diff options
context:
space:
mode:
authorbinarycat <binarycat@envs.net>2025-06-19 13:40:02 -0500
committerbinarycat <binarycat@envs.net>2025-06-19 16:24:13 -0500
commitdfaa6220e22cfed43ea36d958d239c67896a9ceb (patch)
tree81bd2a35d474beeef68bbbd23a1205078f4ebbd3 /.github
parent3bc767e1a215c4bf8f099b32e84edb85780591b1 (diff)
downloadrust-dfaa6220e22cfed43ea36d958d239c67896a9ceb.tar.gz
rust-dfaa6220e22cfed43ea36d958d239c67896a9ceb.zip
add issue template for rustdoc
Diffstat (limited to '.github')
-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 -->