[doc,site] Consider improving the built-in search generated by mdBook
Open
Nobody has claimed this yet.
Component:Doc
Earlgrey-PROD Triaged
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
Description
Some proposals for improvements to the search that would be nice
- Add a way to control the scope of the search
Can it be limited to search only within a HWIP block? Or within a subset of pages?
e.g. the 's' keybind starts a global search, while the 'd' keybind starts a search scoped to the current block.
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 built-in search generated by mdBook and how the documentation site handles the existing global search. Define how search scope should be selected, including the proposed keybindings and limits such as a HWIP block or subset of pages; done means scoped search works without breaking global search.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100