-
Notifications
You must be signed in to change notification settings - Fork 17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Documentation] Search bar for tables within docs #646
Merged
Conversation
This file contains 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
please remove all items in the site/ folder |
sage-wright
reviewed
Oct 10, 2024
sage-wright
reviewed
Oct 10, 2024
sage-wright
reviewed
Oct 10, 2024
sage-wright
reviewed
Oct 10, 2024
updated extra_ javascript for table sort functionality |
sage-wright
reviewed
Oct 16, 2024
sage-wright
approved these changes
Oct 21, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will be so usefull!!! 🌟
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.
🗑️ This dev branch should be deleted after merging to main.
🧠 Summary
This PR adds a search box to the tables within the documentation to improve the user experience when navigating through input and output details.
example markdown table updates wrapping in div with specific class
⚡ Impacted Workflows/Tasks
Documentation: Added search functionality for the input and output tables.
This PR may lead to different results in pre-existing outputs: No
This PR uses an element that could cause duplicate runs to have different results: No
🛠️ Changes
Added a search box above the tables for input and output data to allow filtering table content.
Updated the CSS to ensure the search box styles are applied
Modified the JavaScript to dynamically add search boxes to relevant tables.
⚙️ Algorithm
N/A. The changes are related to the documentation display and user interface improvements.
➡️ Inputs
N/A
⬅️ Outputs
N/A
🧪 Testing
Verified that the search box appears above the input and output tables.
Tested the search functionality to ensure filtering works correctly
Tested search box is present upon page refresh
Suggested Scenarios for Reviewer to Test
Verify that the search box appears above both input and output tables.
Test the search functionality by entering various keywords and ensuring the filtering behaves as expected.
🔬 Final Developer Checklist
🎯 Reviewer Checklist