search

ros-infrastructure / rosindex

The source code for generating index.ros.org
https://index.ros.org
GNU General Public License v3.0
12 stars 24 forks source link

New ROS Index Tutorial #377

Closed CursedRock17 closed 1 month ago

CursedRock17 commented 5 months ago

This pull request is meant to move this pr from ros2_documentation over to ROS Index. It is a basic tutorial and description of the site itself, and is meant to encourage a smoother flow to clients.

rkent commented 4 months ago

I see that others with more experience than me have already commented on the parent PR, but let me add a few comments here from the rosindex perspective.

I don't think you should bury your changes in a link on the about page. You should expand about so that it gives an adequate overview of the site instead. (I would actually do a more radical change, removing all of the external links from the rosindex front page, and including instead an expanded "about" there, but that might be too much of change).

As for search, that is currently woefully under explained. Next to the search field there is a question mark "Help to Search" but that sends you to developer documentation for lunr which really is not of much use to the typical rosindex user. Instead, we need that question mark to link to a rosindex-specific search info page with examples.

At the least we need an example that if I want to search for some topic in a current repo, I would enter for example '+apriltag +distro:iron' in the search bar. That rosindex search info page needs to give a list of the searchable fields as well. The link to the lunr site would just be a "for more info" link in the search info page.