# Doc Presentation

**URL:** <https://internals.rust-lang.org/t/doc-presentation/20532>\
**Category:** documentation\
**Created:** [March 24, 2024, 7:11pm UTC](https://internals.rust-lang.org/t/doc-presentation/20532 "2024-03-24T19:11:59Z")\
**Posts on this page:** 8\
**Page:** 1

<div class="post-metadata">

**Author:** ![Dwarsloeper](https://sea2.discourse-cdn.com/flex002/user_avatar/internals.rust-lang.org/dwarsloeper/32/11073_2.png) [@Dwarsloeper](https://internals.rust-lang.org/u/Dwarsloeper)\
**Post date:** [March 24, 2024, 7:11pm UTC](https://internals.rust-lang.org/t/doc-presentation/20532/1 "2024-03-24T19:11:59Z")

</div>

While I agree that the Rust generated doc is great, I still often find it annoying. I often elatedly click on a promising-sounding function on the left, only to see that it is unsafe, experimental and/or deprecated. I consider these off limits for production code, so I hardly want to be distracted by them.

- I suggest extending the cog-wheel options to allow hiding them. This can (mostly) even be done in pure CSS (e.g. checkbox hack.)

- Independently of this, I would give them different colours, e.g. red instead of green for unsafe (with some colour-blind-workaround) both in the doc and in the sidebar.

- Also I would give them their respective icon(s) 🔥🔬👎 in the sidebar as well.

A lesser gripe are the trait impls, which often consist of mostly signatures with scant text. Since the impl header hardly stands out, this looks chaotic. I would either indent everything under a common heading and/or give it a slightly different background colour.

---

<div class="post-metadata">

**Author:** ![Jules-Bertholet](https://sea2.discourse-cdn.com/flex002/user_avatar/internals.rust-lang.org/jules-bertholet/32/10671_2.png) [@Jules-Bertholet](https://internals.rust-lang.org/u/Jules-Bertholet)\
**Post date:** [March 24, 2024, 8:47pm UTC](https://internals.rust-lang.org/t/doc-presentation/20532/2 "2024-03-24T20:47:31Z")

</div>

I agree with this completely, but unfortunately it seems the Rustdoc team does not see things the same way: [https://rust-lang.zulipchat.com/#narrow/stream/393423-t-rustdoc.2Fmeetings/topic/meeting.2004-09-2023/near/389048618](https://rust-lang.zulipchat.com/#narrow/stream/393423-t-rustdoc.2Fmeetings/topic/meeting.2004-09-2023/near/389048618)

---

<div class="post-metadata">

**Author:** ![Dwarsloeper](https://sea2.discourse-cdn.com/flex002/user_avatar/internals.rust-lang.org/dwarsloeper/32/11073_2.png) [@Dwarsloeper](https://internals.rust-lang.org/u/Dwarsloeper)\
**Post date:** [March 24, 2024, 9:47pm UTC](https://internals.rust-lang.org/t/doc-presentation/20532/3 "2024-03-24T21:47:20Z")

</div>

Oh gosh! Maybe it's time to fire up GreaseMonkey and do it myself…

---

<div class="post-metadata">

**Author:** ![jdahlstrom](https://sea2.discourse-cdn.com/flex002/user_avatar/internals.rust-lang.org/jdahlstrom/32/3351_2.png) [@jdahlstrom](https://internals.rust-lang.org/u/jdahlstrom)\
**Post date:** [March 24, 2024, 10:20pm UTC](https://internals.rust-lang.org/t/doc-presentation/20532/4 "2024-03-24T22:20:25Z")

</div>

It would be great if the elements at the very least had appropriate CSS classnames so they could be easily hidden… but they don’t D:

---

<div class="post-metadata">

**Author:** ![dlight](https://sea2.discourse-cdn.com/flex002/user_avatar/internals.rust-lang.org/dlight/32/8462_2.png) [@dlight](https://internals.rust-lang.org/u/dlight)\
**Post date:** [March 25, 2024, 7:25am UTC](https://internals.rust-lang.org/t/doc-presentation/20532/5 "2024-03-25T07:25:43Z")

</div>

I think this comment refers to performing strikethrough / dimming / etc of certain elements _automatically_ (in their case, deprecated items), not to having an option to hide some kinds of elements depending on user preferences

---

<div class="post-metadata">

**Author:** ![Dwarsloeper](https://sea2.discourse-cdn.com/flex002/user_avatar/internals.rust-lang.org/dwarsloeper/32/11073_2.png) [@Dwarsloeper](https://internals.rust-lang.org/u/Dwarsloeper)\
**Post date:** [March 25, 2024, 7:40pm UTC](https://internals.rust-lang.org/t/doc-presentation/20532/6 "2024-03-25T19:40:37Z")

</div>

Yes, it has a narrower scope. They might still be open to hiding. However, when not hiding, they tend to not want to make the user's life easier. Homogeneous look of the side bar seems to trump usability ("Clicking is free" – no it's not, it wastes time and distracts.) So sorry they shredderd Jules' useful strikethrough attempt!

---

<div class="post-metadata">

**Author:** ![the8472](https://avatars.discourse-cdn.com/v4/letter/t/0ea827/32.png) [@the8472](https://internals.rust-lang.org/u/the8472)\
**Post date:** [March 26, 2024, 12:04pm UTC](https://internals.rust-lang.org/t/doc-presentation/20532/7 "2024-03-26T12:04:23Z")

</div>

In my opinion the left sidebar is just not a good way to explore available methods. A separate method-signature table would be more valuable.

- [Rustdoc hiding important bounds - #11 by the8472](https://internals.rust-lang.org/t/rustdoc-hiding-important-bounds/17753/11)
- [rustdoc: provide summary views · Issue #14475 · rust-lang/rust · GitHub](https://github.com/rust-lang/rust/issues/14475)
- [Documentation needs indexes (function summaries) · Issue #40273 · rust-lang/rust · GitHub](https://github.com/rust-lang/rust/issues/40273)

---

<div class="post-metadata">

**Author:** ![system](https://sea2.discourse-cdn.com/flex002/user_avatar/internals.rust-lang.org/system/32/14092_2.png) [@system](https://internals.rust-lang.org/u/system)\
**Post date:** [June 24, 2024, 12:05pm UTC](https://internals.rust-lang.org/t/doc-presentation/20532/8 "2024-06-24T12:05:05Z")

</div>

This topic was automatically closed 90 days after the last reply. New replies are no longer allowed.
