Documentation
Recipe Style Guide
The structural blueprint for every Meridian recipe — consistent, scannable, and built for speed.
Anatomy of a Recipe
Every recipe follows a rigid skeleton so readers can jump straight to what matters. No fluff, no backstory — just the signal.
- Title — verb-led, outcome-oriented
- TL;DR — one sentence result
- Prerequisites — bullet list, linked
- Steps — numbered, imperative mood
- Verification — expected output
- Cleanup — reversible actions
Voice & Tone
Do
- Imperative mood: “Run the installer.”
- Active voice, present tense
- Second person: “you”
- One idea per sentence
Don’t
- Passive: “The installer should be run.”
- Future tense or hedging
- Third person: “the user”
- Nested clauses or asides
Formatting Rules
| Element | Convention |
|---|---|
| File paths | /etc/nimbus/config.yaml |
| Commands | nimbus init --force |
| Placeholders | <your-api-key> |
| Admonitions | INFO / WARN / DANGER blockquotes |
Pro tip: Before submitting a recipe, read it aloud. If you stumble, rewrite the sentence.