rustdoc book: document sorting of search results
Open
Nobody has claimed this yet.
A-docs
A-rustdoc-search
C-discussion
T-rustdoc
T-rustdoc-frontend
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
currently, the sorting of search results is a bit of a black box. we should add a subsection in the rustdoc book about how the sorting works.
based on this comment.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing rustdoc book structure and the linked pull-request comment describing search-result sorting. Add a subsection that explains how results are sorted, with the work complete when the behavior is understandable from the book without treating the sorting as a black box.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100