Content
65%Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
The instructional content is highly actionable and rich in genuine Windmill-specific knowledge, but the file is bloated by an inline full-SDK reference and the write→test→sync→deploy workflow lacks explicit validation checkpoints.
Suggestions
Move the wmill SDK API reference (roughly lines 186-923) into a separate REFERENCE.md and keep only the import line plus a 'See [REFERENCE.md]' pointer, sharply cutting token cost.
Render the post-write workflow as a numbered checklist with explicit validation gates: write → preview to validate → generate-metadata + diff locks (report version bumps) → deploy only on explicit request.
De-duplicate the SDK entries (e.g. the paired get_*_connection_settings/*_connection_settings, run_script vs run_script_by_path/by_hash, whoami vs user) and mark deprecated ones in a single 'deprecated' subsection.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The CLI and Python-structure sections are dense and carry project-specific knowledge, but ~740 lines of the wmill SDK (full signatures plus Args/Returns docstrings, including duplicates like get_duckdb_connection_settings/duckdb_connection_settings) are dumped inline — verbose, padded context that could be tightened or externalized rather than level-3 lean. | 2 / 3 |
Actionability | Concrete executable commands ('wmill script preview <script_path>', 'wmill generate-metadata --dry-run') and copy-paste-ready Python examples (main(), TypedDict resources, S3 ops) give fully concrete, specific guidance. | 3 / 3 |
Workflow Clarity | The post-write flow (preview vs run vs generate-metadata vs deploy) is conveyed as intent-aware prose with some checks (--dry-run, diffing locks), but it lacks a clear numbered sequence with explicit validate→fix→retry checkpoints for a multi-step, state-mutating process, matching 'sequence present but checkpoints missing or implicit'. | 2 / 3 |
Progressive Disclosure | Section headers give some structure, but the hundreds of lines of inline wmill API reference are exactly the 'content that should be separate is inline' anti-pattern from the level-2 anchor; no reference bundle files exist and the inline SDK should be a one-level-deep REFERENCE.md. | 2 / 3 |
Total | 9 / 12 Passed |