Feat/docs section improvements #6822
Open
+544
−49
Conversation
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
Implemented debounced search to filter docs. Added sorting options by status, name, or URL. Introduced grouping by domain or category with collapsible sections. Improved user experience by providing a clear, flexible interface for managing large documentation sets.
Provides a reusable debounce function to delay execution after user actions. Useful for search implementations and event handler optimizations.
Tests cover search functionality, sorting options, grouping logic, collapsible groups, empty states, and debounce behavior. Ensures stable and reliable implementation of DocsSection improvements.
dosubot
bot
added
the
size:XL
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Enhances the DocsSection component to better handle growing documentation lists by adding search, sorting, and grouping capabilities. This addresses issue #6075 where users reported difficulty managing large numbers of documentation sources.
Key improvements:
• Search: Added debounced search input to filter docs by name or URL
• Sorting: Added dropdown to sort by status (indexing, failed, complete), name, or URL
• Grouping: Added dropdown to group docs by domain or category with collapsible sections
• UX: Empty state when no results match search, clear search button, auto-expand groups when searching
Checklist
I've read the contributing guide
The relevant docs, if any, have been updated or created
The relevant tests, if any, have been updated or created
Tests
Added comprehensive test suite (DocsSection.test.tsx) covering:
• Search functionality with debouncing
• Sorting by status, name, and URL
• Grouping by domain and category
• Collapsible group behavior
• Empty state handling
• Auto-expansion of groups when searching
• Edge cases like empty docs list
The tests ensure all new features work correctly and maintain backwards compatibility with existing functionality.
Summary by cubic
Improved the DocsSection component by adding debounced search, sorting, and grouping to help users manage large documentation lists more easily. This addresses issue #6075 by making it faster to find, organize, and review documentation sources.
New Features
Tests