ros2_documentation icon indicating copy to clipboard operation
ros2_documentation copied to clipboard

Add support for better search tools in docs

Open AbhijithGanesh opened this issue 1 year ago • 4 comments

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

AbhijithGanesh avatar Feb 14 '24 17:02 AbhijithGanesh

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?

kscottz avatar Feb 15 '24 00:02 kscottz

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

AbhijithGanesh avatar Feb 15 '24 15:02 AbhijithGanesh

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

ros-discourse avatar Feb 18 '24 06:02 ros-discourse

@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

AbhijithGanesh avatar Feb 20 '24 15:02 AbhijithGanesh