Content
75%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.
The body is a lean, highly actionable set of rules with specific paths, components, props, and a verification command, organized into a clear topic sequence. It falls just short of top marks because it lacks a full MDX page example, an explicit fix-and-retry loop, and any bundle-file progressive disclosure.
Suggestions
Add a short complete MDX page skeleton showing ReleaseHero, ReleaseFeatureGrid with cards, Upgrade Notes, and the GitHub release link in order.
Make the verification feedback loop explicit, e.g. "If the build fails, fix the MDX and re-run until it passes."
Extract the per-component prop reference into a reference file and link to it from the Page And Components section to lighten the main body.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body is dense imperative guidance with no padding about what release-please or MDX is, e.g. "Write one docs-website MDX page per stable minor release"; it earns a 4 rather than 5 because a few rules about what not to put in cards are slightly redundant. | 4 / 5 |
Actionability | Concrete, executable specifics are given throughout — exact page path `apps/docs-website/src/content/docs/releases/<version-with-hyphens>.mdx`, component names and props (`ReleaseFeatureGrid`, `size="large"`, `status="Unreleased"`), and the build command `mise x -- pnpm --filter docs-website build`; not 5 because no complete copy-paste MDX page example is provided. | 4 / 5 |
Workflow Clarity | Sections sequence the work (evidence → existing text → content → components → images → verification) and the Verification section supplies a concrete build command plus checks; not 5 because the fix-and-retry feedback loop is implicit rather than explicit, and the sequence is implied by section order rather than numbered. | 4 / 5 |
Progressive Disclosure | Content is well-organized into clearly labeled sections with signposted references to real repo paths (AGENTS.md, the components directory); no bundle files exist to navigate and all content stays appropriately inline, so it fits the 4 anchor rather than 5 which expects one-level-deep reference files. | 4 / 5 |
Total | 16 / 20 Passed |