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

Add support for better search tools in docs #4168

Open
AbhijithGanesh opened this issue Feb 14, 2024 · 4 comments
Open

Add support for better search tools in docs #4168

AbhijithGanesh opened this issue Feb 14, 2024 · 4 comments
Labels
help wanted Extra attention is needed

Comments

@AbhijithGanesh
Copy link

AbhijithGanesh commented Feb 14, 2024

Algolia search

The current full-text search supported by Sphinx really misses out on edge cases, I have brought this up on the discourse thread: https://discourse.ros.org/t/growing-issue-with-ros-documentation/36075

I feel we could use the Algolia search to improvize the same

Update

Algolia is closed-source, proprietary AI tool, we need better FOSS alternatives

@kscottz
Copy link
Collaborator

kscottz commented Feb 15, 2024

If you are going to request a feature you need to at least point to the tool you propose we use. My cursory Google search indicates that Algolia is a proprietary AI search tool that costs approximately $0.40 per 1000 searches. We have around 100,000 visitors a month. How do you propose we pay for this?

@AbhijithGanesh AbhijithGanesh changed the title Add support for Algolia in search Add support for better search tools in docs Feb 15, 2024
@AbhijithGanesh
Copy link
Author

I have renamed the issue to "better search" so that we could navigate through all open-source solutions that fit in our issue

@ros-discourse
Copy link

This issue has been mentioned on ROS Discourse. There might be relevant details there:

https://discourse.ros.org/t/improving-search-for-ros-docs-technical/36153/1

@AbhijithGanesh
Copy link
Author

@kscottz we need to decide how to move with this! I've marked my solutions in the thread, all of them will need considerable moving of the docs to a new framework

@wjwwood wjwwood added the help wanted Extra attention is needed label Feb 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants