Documentation for rustdoc search?

tools and infrastructure
1

We couldn't find any documentation about rustdoc search, we can only seem to observe its existence through the search box at the top of every rustdoc page.

Is there such documentation? If not, can there be such documentation?

2

https://doc.rust-lang.org/rustdoc/how-to-read-rustdoc.html#the-search-interface

3

Ah, we mean from a more internals perspective. We guess we can use rustdoc search on rustdoc for rustdoc, and there are a handful of items that come up when looking for search but they have basically no docs: Index of crates

It'd be nice to know how the rustdoc search system works.

4

The search frontend is all in JS, there's no wasm embeds happening for rustdoc (yet? :grin:)

5

This is too low-level and clearly it's just an interface to a rustdoc index.

  1. Is there an human-readable (i.e. not-code) documentation of how the indexing works?
  2. Is there an human-readable outline of the rustdoc search system?
  3. [etc]
6

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