Skip to content

Documentation internationalization

The documentation is bilingual:

txt
/       French documentation
en/     English documentation

Rule

Every Markdown page in the French documentation tree must have a corresponding English page with the same relative path under docs/en/.

Example:

txt
docs/guide/form-builder.md
docs/en/guide/form-builder.md

Check translations

Run:

bash
bun run docs:i18n:check

The script fails if:

  • a French page has no English counterpart;
  • an English page has no French source page;
  • an English page is empty or missing a first heading.

Release integration

docs:build and release:doctor run the i18n check before building the documentation.

Best practice

When adding or renaming a documentation page, update both languages in the same commit.

QForm Builder — reusable Nuxt 4 / Quasar / FormKit layer.