Improve documentation discovery with categorisation and filtering#242
Merged
tombentley merged 5 commits intokroxylicious:mainfrom Mar 29, 2026
Merged
Improve documentation discovery with categorisation and filtering#242tombentley merged 5 commits intokroxylicious:mainfrom
tombentley merged 5 commits intokroxylicious:mainfrom
Conversation
Added icons, badges, and client-side filtering to documentation index pages to help visitors quickly find relevant guides as the guide count grows. - Filter buttons (All, Proxy, Filters, Kubernetes, Developer) with counts - Category icons in card headers using Bootstrap Icons (cpu, puzzle, boxes, code-slash, shield-lock) - Visible tag badges at bottom of cards - Subtle category-specific border colours on cards - Vanilla JavaScript for client-side filtering with progressive enhancement - Cards reflow properly when filtered (no gaps in grid layout) Assisted-by: Claude Sonnet 4.5 <noreply@anthropic.com> Signed-off-by: Tom Bentley <tbentley@redhat.com>
Added two new filter categories to better organise documentation: - Security: for encryption, authentication, and authorisation guides - Governance: for compliance and validation guides Changes: - Added 'security' tag to: Proxy guide, Record Encryption quickstart/guide, OAuth Bearer Validation, SASL Inspection, and Authorization guides - Added 'governance' tag to: Record Validation Guide - Removed overly-specific 'record-encryption' and 'encryption-at-rest' tags - Added Security and Governance filter buttons with shield-lock and check-square-fill icons respectively - Updated icon mapping and CSS border styles for new categories - Applied changes to versions 0.16.0 through 0.19.0 Assisted-by: Claude Sonnet 4.5 <noreply@anthropic.com> Signed-off-by: Tom Bentley <tbentley@redhat.com>
Added comprehensive documentation about the documentation filtering system including structure, current categories, and conventions for adding new filters. This will help maintain consistency when adding new categories or modifying the filtering system in future. Assisted-by: Claude Sonnet 4.5 <noreply@anthropic.com> Signed-off-by: Tom Bentley <tbentley@redhat.com>
The count badge on the All button had two problems: - Visually associated with "All" but showed count for selected filter - Bug: when returning to All, showed previous filter's count (not total) Removed the count entirely as it added confusion without providing sufficient value. The filtering functionality remains unchanged. Assisted-by: Claude Sonnet 4.5 <noreply@anthropic.com> Signed-off-by: Tom Bentley <tbentley@redhat.com>
Member
Author
|
Assuming this gets merged I will make the same changes to the tags in kroxylicious/kroxylicious, so that future releases get categorised in the same way. |
PaulRMellor
approved these changes
Mar 26, 2026
Contributor
PaulRMellor
left a comment
PaulRMellor
left a comment
There was a problem hiding this comment.
Great, Tom!
I made a few comments as I read through
Member
|
@tombentley that looks super! thank you so much. |
Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Tom Bentley <tombentley@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation index pages now include a client-side filtering system to help visitors find relevant guides more quickly. Guides are tagged with categories (Proxy, Filters, Kubernetes, Developer, Security, Governance) and displayed with category-specific icons and visual styling.
The implementation uses vanilla JavaScript for progressive enhancement—the site remains fully functional without JavaScript. Documentation metadata has been updated for recent versions (0.16.0+) to include appropriate category tags.
Changes include:
With All selected (the default):
With an different category selected: