docs: add engagement scoreboard and expand live validation dashboard documentation#190
Merged
Conversation
**Added:** - Introduced `docs/scoreboard.md`, a comprehensive guide for the new live engagement status board powered by `dreadgoad scoreboard` - Added example usage of `dreadgoad scoreboard` commands to `docs/mkdocs/docs/cli-reference.md` and `docs/mkdocs/docs/usage/goad_args.md` - Included new dashboard screenshots for the validation guide (`docs/img/validate_dashboard_running.png`, `docs/img/validate_dashboard_complete.png`) - Added reference to the new scoreboard guide in the main `README.md` and validation documentation **Changed:** - Expanded `dreadgoad validate` documentation in `docs/mkdocs/docs/cli-reference.md`, `docs/mkdocs/docs/usage/goad_args.md`, and `docs/validation.md` to document the live dashboard, polling feature, and clarify output/reporting - Streamlined and modernized `docs/validation.md` to focus on the live dashboard, JSON output, and troubleshooting, removing lengthy manual checklists and redundant sections - Updated main `README.md` and related docs to mention the new live dashboard features and scoreboard integration **Removed:** - Removed obsolete and verbose sections from `docs/validation.md`, including the legacy validation checklist, output walkthroughs, and low-level manual validation advice now superseded by the new dashboard and reporting features
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:
Added:
docs/scoreboard.mddetailing the engagement status board, answer key generation, agent report verification, transport options (local/ssm/ares), and usage walkthroughsdocs/img/validate_dashboard_running.pnganddocs/img/validate_dashboard_complete.pngto visually demonstrate the live validation dashboard in actionChanged:
docs/mkdocs/docs/cli-reference.mdto document scoreboard subcommands (generate-key,run,demo), new validation flags (--plain,--poll), and improved example usage for both validation and scoreboard commandsdocs/mkdocs/docs/usage/goad_args.mddocs/validation.mdto focus on the live dashboard experience, streamlined validation categories, provided new JSON output samples, and described troubleshooting steps for dashboard-based validationRemoved:
docs/validation.mdin favor of concise, dashboard-centric documentation