Welcome to the Nais documentation

See the Nais handbook for a more detailed explanation of the documentation structure and how to contribute.

If a page should have a warning about not being available in test-nais, add the following near the top of the page:

<<not_in_test_nais("Name of feature")>>

Add the following to the frontmatter of the page:

conditional: [not-test-nais, not-nav]

Add the following to the frontmatter of the page:

conditional: [tenant, nav, ssb]
              ^^^^^^--- the keyword "tenant" is required to exclude all not mentioned

Add selected entry-point pages to llms.txt with global ordering metadata:

llms:
  section: Workloads
  order: 30

Pages are grouped by section and ordered by the numeric order. Every rendered documentation page is also available as Markdown at its canonical path with a .md suffix; the root README.md is /index.md.

Four agents handle documentation tasks:

@research-agent → @technical-writer → @plain-language-en → @docs-qa

• @research-agent — Investigates Nais source repos via GitHub MCP. Read-only.
• @technical-writer — Writes/edits docs following repo conventions (Diataxis, mkdocs, Jinja macros).
• @plain-language-en — Copy-edits for plain language, removes AI jargon.
• @docs-qa — Verifies docs accuracy against Nais source code. Read-only.

Start with @research-agent to gather context, hand off to @technical-writer to draft, which auto-hands off to @plain-language-en for polish. Then hand off to @docs-qa to verify accuracy against source code. Use @docs-qa standalone to audit any existing page.

The documentation site lives in svdoc/ and uses SvelteKit, Node.js and pnpm. Tasks are managed with mise.

Follow the mise installation guide. Node.js and pnpm are pinned in mise.toml and installed automatically.

mise run setup

mise run local

This installs dependencies (if needed) and starts the dev server.

TENANT=nav NOT_TENANT=not-nav mise run local:dev

Build one or more tenant-specific versions into out/<tenant>/:

mise run build nav nav test-nais

mise run check              # run all checks
mise run check:lint         # prettier + eslint
mise run check:svelte-check # svelte-check only
mise run check:test         # Vitest unit tests
mise run check:ratchet      # verify GitHub Actions are SHA-pinned
mise run fmt                # format with prettier

Pull requests run all checks in CI. Ratchet is pinned in mise.toml. Pin new GitHub Actions before opening a pull request:

mise exec -- ratchet pin .github/workflows/*.yml

pnpm requires package versions to be at least seven days old. Version-specific exceptions in svdoc/pnpm-workspace.yaml keep the existing lockfile installable. Remove exceptions once those versions are seven days old. Dependabot groups minor and patch updates. Major updates get separate pull requests, except TypeScript majors, which are ignored until the tools support them.