​

Content Style Guide

​

Tone

• Professional, concise, and instructional
• Prefer active voice; avoid marketing fluff
• Use consistent terminology across pages

​

Formatting

• Headings: start from H2 under the page title
• Use short paragraphs and bullet lists
• Include code blocks for commands and configs

​

Components

• Info: for prerequisites or key notes
• Tip: for helpful shortcuts
• Warning: for risks or breaking changes
• Card/CardGroup: for navigation blocks

​

Links

• Prefer relative links within the docs site
• Link to upstream files under _archived/ when referencing canonical sources