Menu
Review and improve Syncpack documentation for clarity, completeness, and consistency. Use when enhancing docs or validating before publication.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
| name | review-docs |
| description | Review and improve Syncpack documentation for clarity, completeness, and consistency. Use when enhancing docs or validating before publication. |
Review and improve Syncpack documentation against project standards.
Use with:
document-code — Reference for structure and locationssignal-over-noise — Apply to remove filler and obvious explanationsfront-loading — Ensure actionable information comes firstGiven a documentation path, review content against standards. Suggest concrete improvements.
site/src/_partials/Provide structured feedback:
Current State
Issues Found
Recommendations
Priority Actions
Docs: site/src/content/docs/
Shared partials: site/src/_partials/
Source of truth: src/ (Rust implementation)
Local testing: cd site && pnpm run dev then verify at http://localhost:4321/syncpack
Rust code style and conventions for Syncpack. Use when writing or modifying Rust code. Covers functional patterns, imports, naming, and quality standards.
Write tests for Syncpack using the TestBuilder pattern. Use when adding tests for commands, validation logic, or any new functionality. Covers TestBuilder API, assertion patterns, and common test scenarios.
Run coverage, inspect results, and identify missing test scenarios for a given source file. Use when analysing test coverage or finding untested branches.
Add new features to Syncpack including commands and validation logic. Use when implementing new CLI commands, adding InstanceState variants, or extending version group behaviour.
Add and update the documentation website for Syncpack. Use when making user-facing changes to the codebase.
Debug and fix bugs in Syncpack using scientific debugging methodology. Use when a test is failing, unexpected behaviour occurs, or investigating issues. Covers hypothesis-driven debugging and TDD-based fixes.