Search results with breadcrumbs. Search with filters by section.

[ksuess]

before:

[ksuess]

I raise the issue, I propose an implementation.

[stevepiercy]

@ksuess how can we implement search by category together with Nuclia search? Now that I have Plone Sphinx Theme stabilized, that's the next big step forward.

[stevepiercy]

Additionally, without hard-coding the categories now, I would prefer to do this upstream in Plone Sphinx Theme. I want to minimize the number of files that we have to modify across the increasing number of Plone documentation sites. We can package template, JavaScript, and CSS files in the distribution now.

[ksuess]

I am aware that this change here will be replaced with a future AI search. And I am fine with it.
Search by category is for me personally 2nd priority. I am fine with not implementing it with a future AI search.
My need for this PR is, that I want to be able to see which search results are relevant for me. For this it is very helpful to see the section/category of a search result. Especially if there are 50+ results of sections backend, frontend, etc..

And, yes, a lift to the theme Plone-sphinx-theme would be great, if it's possible to do it in a way, that the documentation that uses the theme can configure the categories. If that's not possible. I am fine with not implementing the category filter.

[stevepiercy]

Here are my concerns.

• Customizing Sphinx's search JavaScript makes it difficult to maintain when Sphinx releases a new version.
• Keeping categories current in the search-field template is another maintenance task, especially with the continuing reorganization.
• Nuclia may offer this feature, but with a different implementation. I haven't explored it thoroughly, but this video implies it would be possible.

[stevepiercy]

@ksuess until we can implement Nuclia, I'm OK with adding this in the short-term. However, if it breaks from an update to Sphinx or upstream themes, then we'll have to remove it and fallback to the default Sphinx search. Would that be reasonable?

[ksuess]

I am happy with an intermediate solution that adds breadcrumbs or just the category/section to search results.

[ksuess]

If opinions tend to not showing a filter for categories, I am fine with removing this from this PR. My prio is the category on the search result.

[ksuess]

Maybe we can do the change here and kick it out when the AI search is installed.

[stevepiercy]

Agreed. I just submitted a review of the PR. There's a possible bug, a tweak, and a question for you. Thank you!