docs: update CLI docs and validation usage, add scoreboard keybindings, remove validate format flag#202
Merged
Merged
Conversation
**Added:** - Introduced a comprehensive CLI command reference table in the CLI docs, including descriptions and cross-links for each major command - Documented scoreboard TUI keybindings and compact mode behavior in `scoreboard.md` - Added documentation for the `--output` flag to validation quick start and clarified compact mode in `validation.md` **Changed:** - Updated README to clarify the CLI documentation section as a command index and reference, reflecting expanded documentation - Improved formatting and added detail to CLI and validation documentation for better clarity and usability **Removed:** - Removed the `--format` flag from the `validate` command, simplifying output options and updating examples accordingly
dreadnode-renovate-bot
Bot
added
area/readme
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
1 participant
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.
Key Changes:
--formatflag fromvalidatecommandAdded:
commands and their descriptions, improving discoverability for users
compact mode for terminals with limited height
Changed:
both commands and configuration sections for clarity
--outputflag forJSON reports, with improved formatting for readability
terminal height is limited
Removed:
--formatflag from thevalidatecommand to simplify usage and eliminateunsupported output options