workshop-style-guide

You can enforce consistent MDX conventions by applying a style guide that standardizes frontmatter fields, MDX imports like PairId and ValidateCheck, and section shape rules for Crossplane workshop modules. This ensures modules render correctly and maintain structural alignment.

Crossplane workshop modules fail validator checks when task sections lack exactly one ValidateCheck or reference checks missing from the validator registry. Enforcing a strict style guide ensures every task section ends with a valid ValidateCheck backed by the registry.

The required structure for Docusaurus MDX workshop modules includes mandatory frontmatter fields, specific MDX imports such as PairId and ValidateCheck, second-person active voice, short paragraphs, and a consistent content versus task section shape.

Standard markdown is insufficient for Crossplane workshop docs because modules require specific MDX component imports like ValidateCheck and structured frontmatter. Following a dedicated MDX style guide ensures proper rendering and validator compliance.

You prevent unauthorized AI edits by following edit governance guidance that defines AI-edit locks within the style guide. This ensures finished workshop pages are not altered without explicit consent.

This style guide specifically targets Crossplane workshop documentation modules under docs/docs/, focusing on paired tasks, references, and choose-your-own-adventure tracks. It enforces Crossplane-specific validator-check patterns rather than general Docusaurus formatting.