-
Notifications
You must be signed in to change notification settings - Fork 22
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
Not obvious how to search through documentation #232
Comments
Interestingly, if you type something in that search box and then hit the https://index.ros.org/search URL, you do get the option to search through the documentation and tutorials as well. So the backend is there, its just presented poorly. I think this should probably be presented on the front page somehow. |
Hmm, @rotu can't you select the
That's a fair point. Since content is arguably unrelated, at the time I thought a Github search-like UI with categories would work best. I explored putting all content sequentially in a single page and I found it somewhat impractical e.g. either the page layout was too lengthy or each category would show way too few elements to be useful. But this is all subjective. |
Yes! But silly me, I didn't even notice that tab until @clalancette pointed it out! My mind must have just assumed that was for API documentation pages like http://docs.ros2.org/dashing/api/rclcpp/classrclcpp_1_1Node.html That tab bar was a visual cue that these are "similar" things like the distro selection on a package page. It might be enough to just have the search results default to the "Documentation" tab when you search from a doc page. |
There's a lot of great documentation and tutorials on index.ros.org, but it's not as discoverable as it could be. When I'm browsing the docs, the "Search ROS" search box at the top right only searches through packages - it would be nice to have a search box for the documentation and tutorials.
The text was updated successfully, but these errors were encountered: