Skip to content
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

Missing functionality in Search #120

Open
amirhouieh opened this issue Oct 18, 2023 · 2 comments
Open

Missing functionality in Search #120

amirhouieh opened this issue Oct 18, 2023 · 2 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@amirhouieh
Copy link
Contributor

amirhouieh commented Oct 18, 2023

Copy/pasting from https://github.com/status-im/infra-misc/issues/143#issuecomment-1768331627 by @zah

If we use the framework for the Nimbus guide, I feel the quality of the search box will be lower in comparison to our current solution. In particular, our current system (https://www.mkdocs.org/) offers the following features:

  1. When you search, you can navigate and select search results by using the arrow keys on your keyboard (pressing ENTER takes you to the selected result).

  2. The offered instant results feature snippets that show the content around the matched search keywords, which makes it easier for the user to select the right page to navigate to.

Please note that this doesn't seem to be a limitation of Docusaurus itself, but rather a problem in the current implementation. As an example, the documentation site of Prysm is based on Docusaurus and has a decent search box:

https://docs.prylabs.network/docs/getting-started

Originally posted by @zah in https://github.com/status-im/infra-misc/issues/143#issuecomment-1768331627_

@jeangovil
Copy link
Contributor

@zah, thank you for raising the issue. We will implement the changes you've suggested. It's worth noting that Docusaurus doesn't have built-in local search functionality. We've extended an open-source plugin and implemented our own UI.

If you come across any other issues or have more ideas for improvement, feel free to open a new issue in this repository.

@amirhouieh amirhouieh added the enhancement New feature or request label Oct 18, 2023
@amirhouieh amirhouieh added this to the beta milestone Oct 18, 2023
@zah
Copy link

zah commented Oct 18, 2023

For reference, you can see how the Nimbus Guide search works here:
https://nimbus.guide/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Backlog
Development

No branches or pull requests

4 participants