Content
85%Weight 40%Scale 1-5Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
Highly actionable body with concrete code, clear sequenced workflows, and validation feedback loops for destructive formatting changes. The main defect is that all docs/ references point to non-existent bundle files, undermining the progressive-disclosure structure.
Suggestions
Ship the referenced docs/ bundle (docs/reference/syntax.md, docs/tutorial/writing-in-typst.md, etc.) or remove/replace the dangling links so every referenced path resolves to a real file.
Consolidate 'Common mistakes to avoid' and 'Quick syntax reference' into the bundled docs to reduce inline length while keeping only the highest-value gotchas.
Verify the metadata/query probe example target paths (docs/reference/introspection/query.md, metadata.md) exist, since the probing workflow depends on them.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | Mostly lean and actionable with domain-specific gotchas rather than generic Claude knowledge, but a few sections (e.g. 'Common mistakes to avoid' and 'Quick syntax reference') could be tightened and consolidated into the bundled docs. | 4 / 5 |
Actionability | Provides copy-paste ready code (minimal document example, set/show rule snippets) and specific executable commands like 'typstyle --check <file>', 'typst query - "<probe>" --field value --one', and 'command -v typstyle' covering common cases. | 5 / 5 |
Workflow Clarity | Detailed instructions are sequenced 1–7 with explicit validation checkpoints ('typst compile', 'typstyle --check') and a feedback loop (fail → 'typstyle --diff' → decide), plus a destructive-code guard ('Stop and ask the user when formatting would change untouched pre-existing code'). | 5 / 5 |
Progressive Disclosure | Sections are well-organized and references are signaled as one-level-deep links into docs/, but the referenced docs/ directory and files (e.g. docs/reference/syntax.md, docs/tutorial/writing-in-typst.md) do not exist in the bundle, so navigation is broken despite the intended structure. | 3 / 5 |
Total | 17 / 20 Passed |