Discussions/Background to improve HTML outputs of rustdoc

[zjp-CN]

NOTE: these are not motivations to create term-rustdoc. I was not even aware of each of them before writing term-rustdoc.

Rust Project Goals

• Make Rustdoc Search easier to learn rust-lang/rust-project-goals#112

Rust-Lang issues

• rustdoc: provide summary views rust-lang/rust#14475
  • It seems to heavily overlap with motivations of term-rustoc.
  • There are many thoughts on that page, everyone has own idea to improve UI/functionalities. But specific to the mere title, it reads to me a summary list for fn signatures is wanted which can be put in these places: data structure's inner item and content panel for impl block item.

Official Internals Forum

• pre-RFC: List all re-exported items, including those imported by wildcards, in rust docs
  • support for reexported items that are defined in local crate
    • including edge cases for recursive reexports:
      Recursive reexported module should stop when the inner module duplicates as ancestor module #3
  • support for reexported items that are defined in external crates:
    Reexported external items need external crates compiled to know the details #8
• RustDoc: Group methods for easy of navigation
  • outline-design
• How do you discover crate features when using a new crate?
  • We need a standard way to write/know descriptions of features, but term-rustdoc has generated a better UI for feature selection!
• Sidebar with colors and more stlyish things
  • term-rustdoc already distinguishes items with colors
• Rustdoc hiding important bounds
  • a topic to have flatten trait bounds view: specific to that post, bounds on impl block should be added to each function/method
• add LLM text version to rustdoc

Reddit

• Does anyone else find Rust docs almost impossible to browse?