Skip to content
Darkone NixOS Framework

Contributing to the documentation

This site is built with Astro 🡕 and Starlight 🡕. Pages live under src/content/docs/<lang>/ (fr, en).

Where to write

Section titled “Where to write”
  • doc/<section>.mdx — a section’s entry page: introduction + links.
  • doc/<section>/<leaf>.mdx — detail leaves.
  • Short cross-cutting topics → doc/how-to/{user,admin,dev}/.

Write in French (fr/); English is produced afterwards by just translate. Slugs and file names stay in English.

Essential rules

Section titled “Essential rules”
  • Max 7 headings per level, depth 3.
  • <Steps> for step sequences, <Aside> (with a title) for callouts.
  • Card/CardGrid are reserved for the user guide.
  • See the help & how-to and the role skills.

Tools

Section titled “Tools”
Fenêtre de terminal
just dev      # development server
just tags     # refresh translation tags
just build    # build the static site
just test     # tests + internal link validation