Skip to content

Add a docs page

The docs live in site/ in the app repository. A page is one .mdx file; the sidebar, search index, sitemap and related links are built from its frontmatter.

  1. Create site/src/content/docs/<section>/<name>.mdx, where the section is getting-started, basics, app, ai, processings or contributing.
  2. Fill in the frontmatter: title, description (at most 155 characters), slug (the path without .mdx), section, level, tags, related, updated, and pageType: howto if the page has numbered steps.
  3. Put a <Screenshot> or figure near the top. To add a screenshot, add a shot to site/scripts/screenshots.mjs and run npm run docs:screenshots.
  4. Write the page with the shared components: Steps, Callout, Screenshot, ProcessingFigure, ParamTable, OpenInEditor, LevelBadge and Related.
  5. Run npm run docs:check, then npm run docs:build, and fix what they report.

English pages sit at the root of site/src/content/docs/. A Dutch page goes in site/src/content/docs/nl/ under the same path, with slug: nl/<path>. The Dutch locale switches on by itself when its first page exists. Pages without a translation then show the English text with a notice, and point search engines to the English page. Run npm --prefix site run translation-status to list pages that still need a translation. Docs interface text is in site/src/content/i18n/.