[doc] Search improvements

[adangel]

Describe the PR

Improves the integrated search in the documentation:

• displays the results in a more readable way
• allow to use simple keyboard shortcuts: press "s" to focus the search field, use arrow up/down to navigate the results
• display the rule descriptions in the search results
• as our rule names are using PascalCase, I split these into single words so that rules can be found by part of their name.
• display 20 results and make it scrollable
• disable fuzzy search. without it more understandable results are returned.

Old:

New:

Related issues

• Fix #

Ready?

• Added unit tests for fixed bug/feature
• Passing all unit tests
• Complete build ./mvnw clean verify passes (checked automatically by github actions)
• Added (in-code) documentation (if needed)

[pmd-actions-helper]

Documentation Preview

No regression tested rules have been changed.

(comment created at 2025-10-24 12:59:21+00:00 for 8b0adeb)

[zbynek]

The new layout is nice!

Two (Chrome/Windows specific?) issues: when search is not active, there is an empty search box:

When it is active, there are both vertical and horizontal scrollbars, even if they are not needed. Would it make sense to have just overflow-y: auto to fix both of these isues?

For renamed rules this gives the same description for both the new and the deprecated one -- it might be useful to replace the description of deprecated rules with just the word "Deprecated.".

Suggestion for the future: Simple Jekyll Search has a new maintainer and the new version seems to have some useful features (e.g. ignores word order, unless quotes are used) https://github.com/neilboyd/Simple-Jekyll-Search .

[adangel]

The new layout is nice!

Thanks!

Two (Chrome/Windows specific?) issues: when search is not active, there is an empty search box: When it is active, there are both vertical and horizontal scrollbars, even if they are not needed. Would it make sense to have just overflow-y: auto to fix both of these isues?

Yes, I thought/wanted to use "auto". I'm using Firefox, which seems to be different in this regards doesn't force scrollbars. Anyway, using overflow-y: auto now...

For renamed rules this gives the same description for both the new and the deprecated one -- it might be useful to replace the description of deprecated rules with just the word "Deprecated.".

Good idea, I've added this. We might need to experiment a little bit with the presentation, but it's better now.

Suggestion for the future: Simple Jekyll Search has a new maintainer and the new version seems to have some useful features (e.g. ignores word order, unless quotes are used) https://github.com/neilboyd/Simple-Jekyll-Search .

Thanks for the hint - yes. At some point, we should update...

[zbynek]

Scrollbar issues are fixed now.