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

[Doc] [Discussion] A better search system #230

Closed
alex3236 opened this issue Feb 27, 2023 · 1 comment
Closed

[Doc] [Discussion] A better search system #230

alex3236 opened this issue Feb 27, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request low priority reasonable, but not that important

Comments

@alex3236
Copy link
Contributor

alex3236 commented Feb 27, 2023

There are a number of problems with the current search system for documentation - Slow search speed, incorrect or missing results, etc.

We could introduce a better search system.

According to readthedocs/sphinx_rtd_theme#761, it's possible to add Algolia to sphinx. As a matter of fact, there are some projects that already do this, such as sgkit.

It works well:
1

When we do the same search in MCDR's documentation:
2

I think a proper discussion is necessary. I would have liked to do some testing myself, but Algolia has to be applyed by the repository owner in order to be used, and I didn't want to create a separate dummy document for testing purposes.

@Fallen-Breath Fallen-Breath added enhancement New feature or request low priority reasonable, but not that important documentation Improvements or additions to documentation labels Feb 27, 2023
@Fallen-Breath
Copy link
Collaborator

implemented in #234

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request low priority reasonable, but not that important
Projects
None yet
Development

No branches or pull requests

2 participants