Documentation website

Docusaurus 3 site with docs at the site root (routeBasePath: /). Published at octree-gva.github.io/decidim-toggle.

Site layout

website/docs/
  index.md              # Homepage
  integrate/            # Module developers
  developer/            # Gem contributors

Sidebar is autogenerated from the folder tree (sidebars.ts).

Page structure

Every content page follows the same shape:

1. Front matter — title, description, sidebar_position
2. H1 — matches the page title
3. Metadata — Who reads this, Prerequisite (when applicable), Next (reading-order hint)
4. Intro — one short paragraph
5. Body — ## sections with steps, tables, or code
6. See also — links back to the section index, siblings, and cross-section pages

Homepage (index.md) uses the same metadata block; See also is a table of entry points.

Edit locally

cd website
yarn
yarn start

Build before merge

cd website && yarn build

onBrokenLinks: 'throw' — fix broken links before merging. GitLab job node::docs runs the same build on MRs and main.

Images

Static assets: website/static/img/. Reference from markdown as /img/filename.png.

See also

• Contribute
• Overview