docs: update CLI reference, README, and site docs for v0.23+ features#167
Merged
Conversation
- Add 10 missing waza run flags to README (--output-dir, --tags, --model, --recommend, --judge-model, --session-log, --session-dir, --no-summary, --update-snapshots, --skip-graders) - Add waza session list/view commands to README - Add waza grade and waza session sections to site CLI reference - Add missing waza run flags to site CLI reference - Create .waza.yaml project configuration reference page - Fix grader descriptions for tool_constraint and trigger - Fix trigger_tests → trigger reference in cli.mdx - Fix HTML comments → MDX comments in eval-yaml.mdx, graders.mdx, schema.mdx Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the documentation set to reflect newer Waza CLI/config features (v0.23+), including new CLI flags/commands and a new .waza.yaml reference page, plus MDX/cspell comment fixes.
Changes:
- Added a new
.waza.yamlproject configuration reference page with section-by-section tables and examples. - Expanded the CLI reference and README to cover additional
waza runflags pluswaza gradeandwaza sessioncommands. - Updated grader documentation text and converted HTML comments to MDX-compatible JSX comments for cspell directives.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| site/src/content/docs/reference/waza-yaml.mdx | New .waza.yaml reference page documenting config sections, defaults, and examples |
| site/src/content/docs/reference/schema.mdx | Adjusted cspell ignore directive to MDX JSX comment syntax |
| site/src/content/docs/reference/cli.mdx | Added newer waza run flags and new sections for waza grade and waza session; updated trigger grader naming |
| site/src/content/docs/guides/graders.mdx | Updated grader descriptions and MDX cspell comment syntax |
| site/src/content/docs/guides/eval-yaml.mdx | Updated MDX cspell comment syntax |
| README.md | Expanded CLI flag list and added waza session docs |
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
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.
Comprehensive docs update: adds missing waza run flags, waza grade/session sections, .waza.yaml reference page, fixes grader descriptions and MDX comment syntax.