Update docs #777
Merged
Update docs #777
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
Add "Shell Completion" and "Container Logs View" sections to the README table of contents to improve documentation coverage and help users discover these features more easily.
Add documentation for the new pod column customization feature in README. This includes: - Adding it to the table of contents - Adding feature description in the Features section - Adding CLI option details - Creating a dedicated section explaining usage and limitations This helps users understand how to customize pod table columns using the new --pod-columns flag.
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation to include details for new features.
- Adds entries in the Table of Contents for "Pod Column Customization" and "Shell Completion".
- Introduces a new command-line option (--pod-columns) along with a dedicated section explaining its usage.
- Updates the features list to highlight the newly supported pod columns option and the container logs view.
Comments suppressed due to low confidence (1)
README.md:61
- Consider standardizing the naming of the new pod column feature. The TOC and the section title refer to it as 'Pod Column Customization', so renaming this entry to match would improve consistency.
+ - **(new) Customizable pod columns**
Add detailed explanation for the --pod-columns flag, specifying that it supports comma-separated lists or 'full' option to show all columns. This improves user understanding of the feature's capabilities.
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.
No description provided.