search

readthedocs / readthedocs.org

The source code that powers readthedocs.org
https://readthedocs.org/
MIT License
7.98k stars 3.57k forks source link

Gallery of images/snippets and allow searching over them #7214

Open stsewd opened 4 years ago

stsewd commented 4 years ago

This feature will be similar to the "gallery" tab you often see in chats.

How would this be useful?

Often you remind more an image/snippet from a section rather than the text around the section. Having a gallery of them linking to the section where they belong would be useful. Also, even better, allow search over them. Allowing search for snippets is obvious , for images, we can index the description (caption), the alt attribute (or fallback to it), the section where it belongs, and maybe fallback to the file name too.

We already identity code snippets, and I have PoC that allow us to index them and show them nicely in inline results https://github.com/readthedocs/readthedocs.org/pull/7112/ (isn't that complicated).

I don't think we can display inline results for images, so we need to have a tab to show them, we can integrate this into the dashboard till we find a better UI/UX for show them (or link them from) in the indoc-search.

I'm creating this issue to keep track of this idea, and see if there are other people that think this feature is useful (or already want it p:)

humitos commented 11 months ago

We have a modal that's shown for search "text" currently. We could add a new tab there to show all the images the documentation contains and allow to search over there as well.

We can probably talk about this in one of our meetings and grab some feedback, ideas, and priorities from the whole team.