Skip to content

Allow for multiple hits per search result #5212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
agjohnson opened this issue Feb 1, 2019 · 1 comment
Closed

Allow for multiple hits per search result #5212

agjohnson opened this issue Feb 1, 2019 · 1 comment
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required

Comments

@agjohnson
Copy link
Contributor

Currently, our search results only display the first, and hopefully the best, search term found in the page. On clicking through to the result page, this requires having to manually scan a potentially large page for your search term. If we were able to support linking to individual search terms in documents, it would be easier to scan for the search hit.

I'm not sure if there is a good way to do this with our current index, but if not, I could see section indexes being helpful here. An example of a search the allows for multiple hits per page is the webpack docs. The search here links to the section heading containing the search result instead of to the individual search hit.

This depends on #4281 in some fashion, unless we go with section indexing.

@agjohnson agjohnson added the Needed: design decision A core team decision is required label Feb 1, 2019
@agjohnson agjohnson added this to the Search improvements milestone Feb 1, 2019
@agjohnson agjohnson added the Improvement Minor improvement to code label Feb 4, 2019
@dojutsu-user dojutsu-user removed this from the Search improvements milestone Jul 25, 2019
@dojutsu-user
Copy link
Member

Closing this as the code related to its already deployed in production.
More info: https://blog.readthedocs.com/improved-search-and-search-as-you-type/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required
Projects
None yet
Development

No branches or pull requests

2 participants