How these docs are organised
These docs use BookStack's four levels. Each level has one job.
| Level | Used for | Example |
|---|---|---|
| Shelf | A broad area of oiv.ae | Mirrors |
| Book | One product, service or programme | mirrors.oiv.ae |
| Chapter | A group of related tasks inside a book | Use the mirror |
| Page | One task or one topic, readable in a few minutes | OPNsense |
Shelves
- oiv.ae: what the project is and how to take part.
- Mirrors: using and running mirrors.oiv.ae.
- Community: guides, events and Arabic localisation.
- Brand and design: the oiv.ae logo, colour and type, and how the site applies the UAE Design System.
Writing conventions
- Page titles say what the reader will do or learn: "Use the mirror with openSUSE", not "openSUSE".
- Start each page with one or two sentences on what it covers. The page title is already shown as the heading, so body sections start at Heading 2.
- Put commands in code blocks, one command per line, so they can be copied.
- Mark unfinished pages with a yellow warning callout that says "Draft outline".
- Tag pages with
Section,Topic,DistroandAudiencewhere they apply, so search filters work.