leanprover / leanprover/reference-manual
search: section titles are sometimes buried under API documentation entries
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 129
- Forks
- 67
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 16
Description
Sometimes, section titles are not well-discoverable using the search because they are buried under much more "nichey", low-level entries.
Reproduction steps:
Search for "Lake".
(I need to go two pages (search box heights) down to actually find the "22.1 Lake" section is was looking for.
Expected behavior:
At least in this specific example, I think the search would benefit from having the "Lake" section as the top entry. However, this is a special case, and in general, there can be situations in which one wishes another item (with a better match) to be listed higher than a section title.
So I think the expected behavior is that the search increases the score of the sections, but does not always strictly prioritize them.
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 reproducing the search for "Lake" in the reference manual and locate the search-ranking entry point. Compare the section result with the API documentation entries, then adjust the ranking so section titles receive a boost without always taking priority; done means the section is more discoverable while stronger matches can still rank higher.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, search
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100