Skip to main content

Writing style

The theme sets how the docs look. This page covers how they should read, from the design system's content fundamentals.

Voice​

Calm, precise, plain. Say what things are or do. Quietly confident, never hyped.

  • Sentence case everywhere: page titles, headings, sidebar labels, buttons, tabs. No all-caps labels.
  • "We" for the team, "you" for the reader.
  • No emoji, no exclamation marks.
  • No superlatives or buzzwords: not "revolutionary", "cutting-edge", "seamless", "next-gen".
  • Never invent facts. No made-up customers, metrics or testimonials, not even as placeholders.

Buttons name the action: "Get started", "Install the theme", "Delete project". Never "Submit", "OK" or "Learn more".

Link text says where it goes. Write "read the configuration guide", not "click here".

Errors and warnings​

Say what happened and how to fix it.

danger

Enter a full email address, like [email protected].

Imagery​

No stock photos and no AI-generated illustrations. The pattern, diagrams and real product screens are the imagery. Never use mosque, dome, arch, crescent or lantern motifs, Arabic calligraphy as decoration, or faux-Arabic lettering.

Checklist​

Before you publish a page:

  1. The title and headings are in sentence case.
  2. Each heading level follows the one above it; there's one H1.
  3. Every image has alt text, or is marked decorative.
  4. Status is never shown by colour alone.
  5. Admonitions say what to do, not only what's wrong.