docs: add cache command, prompt mode, and complete schema reference#198
Merged
Conversation
- Add waza cache clear command to CLI reference with flags and examples - Add mode field to Prompt grader in graders guide (independent/pairwise) - Add missing config fields to schema reference: max_attempts, group_by, fail_fast, skill_directories, required_skills, mcp_servers - All 16 documentation pages build successfully Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the documentation site to close gaps in the CLI reference, graders guide, and YAML schema reference—aligning the docs more closely with the current waza implementation.
Changes:
- Adds
waza cache clearto the CLI reference with flags and examples. - Documents the
modeoption for thepromptgrader (independent/pairwise). - Extends the YAML schema reference with additional
configfields.
Show a summary per file
| File | Description |
|---|---|
site/src/content/docs/reference/schema.mdx |
Adds missing config fields to the schema reference (max_attempts, group_by, fail_fast, skill_directories, required_skills, mcp_servers). |
site/src/content/docs/reference/cli.mdx |
Adds CLI reference section for waza cache / waza cache clear. |
site/src/content/docs/guides/graders.mdx |
Adds mode field to the prompt grader options table. |
Copilot's findings
Comments suppressed due to low confidence (1)
site/src/content/docs/reference/schema.mdx:224
- Type notation here (
list[string]) is inconsistent with the rest of the docs, which uselist[str](e.g., guides/eval-yaml.mdx and guides/graders.mdx). Consider switching tolist[str](orarray[string]) for consistency across the documentation site.
**Type:** list[string]
**Default:** `[]`
- Files reviewed: 3/3 changed files
- Comments generated: 5
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.
Fixes 3 documentation gaps in the site:
Gap 1: Add
waza cacheto CLI referencewaza cache clearcommandGap 2: Add
modefield to Prompt grader docsGap 3: Complete schema.mdx config fields
Verification: