Writing Guidelines #

Recommended page structure #

1. Start with one-sentence summary
2. Add a short prerequisites block (if needed)
3. Use step-by-step sections with clear headings
4. Include copy-ready command blocks
5. End with troubleshooting or next steps

Markdown conventions #

• Use sentence-case headings
• Keep sections short and task-focused
• Prefer bullets for options and checks
• Use fenced code blocks for commands

Component usage guidelines #

• Use Alert for warnings or important context
• Use Callout for tips or notes
• Use CardGrid for overview hubs
• Use CodeBlock via fenced code blocks for commands

Clarity rules #

• One action per step
• One command block per outcome
• Avoid mixing conceptual and procedural text