From 6f583e18bf58fbfeab90205b75dbc38380831dd2 Mon Sep 17 00:00:00 2001 From: Olivier 'reivilibre Date: Thu, 30 Oct 2025 12:09:23 +0000 Subject: [PATCH] Add rest of documentation on `templates check` --- docs/reference/cli/templates.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/reference/cli/templates.md b/docs/reference/cli/templates.md index c6423b32b..9877f3af9 100644 --- a/docs/reference/cli/templates.md +++ b/docs/reference/cli/templates.md @@ -21,3 +21,13 @@ INFO mas_core::templates::check: Rendering template name="index.html" context={" Options: - `--out-dir `: Render templates and emit them to the specified directory, which must either not exist or be empty. - `--stabilise`: Remove sources of nondeterminism from template inputs, so that renders are reproducible. Only useful with `--out-dir`. + +What is checked: +- the Jinja templates are syntactically valid +- the templates can render with a few sample values, with the branding from the MAS configuration + - undefined variables (`{{ undefined_variable }}`) will raise errors +- all translation keys exist + +What is not checked: +- the validity of the generated HTML (you can forget closing tags, or otherwise create invalid HTML output) +- all translation keys exist *in your intended language(s)* (so some translation keys may fall back to English)