feat: Add a documentation problem issue template

[gimbling-away]

Fixes #98722 :)

[rust-highfive]

r? @Mark-Simulacrum

(rust-highfive has picked a reviewer for you, use r? to override)

[alice-i-cecile]

Should this capture the Rust version in the template too? I can see the appeal of using a very minimal template instead though.

[gimbling-away]

Should this capture the Rust version in the template too? I can see the appeal of using a very minimal template instead though.

I don't..think that will be quite useful? No point in reporting a doc problem that happened a release or two ago but fixed on latest :D

Although I think I might be misunderstanding what you meant by that

[alice-i-cecile]

My thought was that you want to be able to check that the problem wasn't already fixed by another change that forgot to mention the issue.

But I suppose that because doc issues are almost always trivial to verify, it's really not worth it.

[Mark-Simulacrum]

@bors r+ rollup

Seems like a good start, and we can always iterate in the future. Thanks!

[bors]

📌 Commit de9b1da has been approved by Mark-Simulacrum

[ehuss]

I'm wondering if it might be helpful to direct the user to the appropriate repo in the comment. Documentation lives all over the place, and going through the rigamarole of having them close and reopen can be annoying. I can transfer issues between some repos, but not all of them.

For example, it could say:

Some docs have their own dedicated issue trackers. If the issue is for one of the following, please consider filing the issue in the corresponding tracker:

• The Rust Programming Language ("The Book"): https://github.com/rust-lang/book/issues
• Cargo: https://github.com/rust-lang/cargo/issues
• Rustup: https://github.com/rust-lang/rustup/issues
• Rust by Example: https://github.com/rust-lang/rust-by-example/issues
• The Reference: https://github.com/rust-lang/reference/issues
• The Edition Guide: https://github.com/rust-lang/edition-guide/issues
• The Rustonomicon: https://github.com/rust-lang/nomicon/issues
• The Embedded Rust Book: https://github.com/rust-embedded/book/issues
• The Website (https://www.rust-lang.org/): https://github.com/rust-lang/www.rust-lang.org/issues

All other documentation issues should be filed here (including The Standard Library, The Rustc Book, The Rustdoc Book, The Rust Unstable Book, and anything else).

---

That might be a bit too much or overwhelming, so I'm not sure if it makes sense. I only need to transfer an issue about once a month, so it doesn't happen too often. Also, most of those docs have links directly to their GitHub repos, so most users seem to be able to find their way. What do you think?

[alice-i-cecile]

I personally like those links quite a bit, but I like long issue templates much more than the average user 😆

Perhaps list what does fit here, and then link to an external page for "everything else"?

[gimbling-away]

I personally like those links quite a bit, but I like long issue templates much more than the average user laughing

Perhaps list what does fit here, and then link to an external page for "everything else"?

We could have the list in a comment in the template, so it wouldn't be shown in the render =)