workshop-style-guide

What problem does it solve?

It prevents workshop documentation from drifting into inconsistent voice, structure, MDX conventions, and validator-check behavior that breaks authoring alignment and participant outcomes.

Core Features & Use Cases

• Voice, tone, and section shape rules: Enforces second-person active voice, short-and-sharp paragraphs, and a consistent content vs task structure.
• MDX and component conventions: Standardizes frontmatter, imports (PairId / ValidateCheck), and MDX patterns so modules render correctly.
• Validator-check discipline: Ensures every task section ends with exactly one ValidateCheck and that referenced checks exist in the validator registry.
• Safety and edit governance guidance: Defines how to handle AI-edit locks so finished pages are not altered without explicit consent.

Quick Start

Open the guide and use it as the checklist when drafting or reviewing a workshop module so it matches the conventions used by the shipped modules in docs/docs/.