Menu
Fix compliance issues in a documentation file against writing style and mdoc conventions.
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 | docs-verify-compliance |
| description | Fix compliance issues in a documentation file against writing style and mdoc conventions. |
| argument-hint | [docs-file.md] |
| allowed-tools | Bash |
Run these commands in order:
/docs-check-compliance $ARGUMENTS docs-writing-style
/docs-check-compliance $ARGUMENTS docs-mdoc-conventions
sbt "docs/mdoc --in $ARGUMENTS"
Fix all violations identified by /docs-check-compliance, committing each separately. Ensure the final mdoc compilation succeeds with zero errors.
Write a how-to guide for practitioners accomplishing a specific task with a ZIO library. Guides are goal-oriented and task-focused, not pedagogical. Use when writing step-by-step practical guides.
Write a tutorial for newcomers learning a topic in a ZIO library. Tutorials teach concepts step-by-step in a linear path for learning-oriented, not task-oriented, purposes. Use when writing comprehensive learning guides.
Reference for mdoc code block modifiers and Docusaurus admonitions used in ZIO documentation. Use when writing or reviewing documentation with Scala code examples.
Write reference documentation for a module containing multiple related data types. Use when documenting a cohesive domain model (e.g. http-model, resource-management) where types work together as a system.
Write reference documentation for a specific ZIO data type. Research the type, write comprehensive documentation with examples, verify mdoc compilation, and integrate into docs.
Integration checklist for new ZIO docs pages. Handles sidebar wiring, index.md linking, and compilation gate (mdoc + Docusaurus build). Cross-referencing is handled separately by the integrate workflow (Phase 2).