Documentation site based on Nextra docs (based on next.js)

to run the project

pnpm i (install the dependencies) pnpm run build (do one build) pnpm run dev (or start for a local development server)

Then the project should be available under http:localhost:3010/documentation

prerequisites

It's recommended to use volta

"node": ">=22.0.0",
"pnpm": ">=9.0.0"

Development

The project is setup to work with spec-kit. Use Copilot or Claude create specs and implementations.

More details.

i18n

The project uses Crowdin (TBD) for internationalization (i18n) management. All English .mdx files automatically generate corresponding .nl versions through Crowdin.

Translation Process:

• Do not edit Dutch translation files directly in the repository.
• All translations must be done through the Crowdin platform.
• When English content is updated or new pages are added:
  1. Changes sync automatically to Crowdin after it was merged to develop.
  2. Translators update Dutch versions in Crowdin.
  3. Translated content is pulled back into the repository via a Crowdin-generated PR.

Handling Crowdin Updates:

• Crowdin pushes unsigned commits to a l10n_develop branch.
• After translating the content, the translator should:
  1. Create a new branch (e.g., git checkout -b translations-<date>) from the up-to-date develop branch.
  2. Squash all unsigned commits from Crowdin:

     git merge l10n_develop --squash

  3. Commit the changes with a clear message:

     git commit -s -m "translation updates"

  . Publish the branch and create a PR against develop.

Build & Deployment

The build and deployments are automatic on merge.

In order to deploy it to dev/acc, merge to develop branch.

For production release you need to merge to main branch. For proper redeployment make sure you bump the version on every merge to main.

Use the following:

npm version patch

this will bump the patch version and make a commit (e.g. 0.0.1 -> 0.0.2).

Once merged into main, make sure to merge main back to develop (to sync the version).