Documentation Style Guide

Version: 0.1.0

To maintain high quality and consistency across ReasonKit documentation, please adhere to these guidelines.

Voice and Tone

Authoritative but Accessible: Write with confidence, but avoid jargon where simple words suffice.
Concise: Get to the point. Avoid fluff.
Active Voice: “The engine processes data” (Good) vs “Data is processed by the engine” (Bad).
Objective: Avoid marketing hype (“blazing fast”, “best in class”) unless backed by benchmarks.

Use sentence case for headers.

# Getting started (Bad)
# Getting Started (Good)

Always specify the language for syntax highlighting.

// Good
fn main() {}