fix: standardize Liquid syntax references in documentation

- Updated various documentation files to replace HTML-encoded Liquid syntax with the standard format `{{ ... }}` for consistency and clarity.
- Ensured that all instances of `context.data` and related examples reflect the correct syntax, improving readability and preventing rendering issues.

Author: mokhld

.github/scripts/docs/fix-docs.sh

@@ -70,8 +70,13 @@ for dir in code-based configuration-based; do
         # Replace %} with %}
         line="${line//%\}/%}}"
         echo "$line" >> "$temp_file"
+      # Check for inline code with Liquid syntax (surrounded by single backticks)
+      elif [[ "$line" =~ \`[^\`]*(\{\{|\{%).*\` ]]; then
+        # Replace single backticks containing Liquid syntax with double backticks
+        line=$(echo "$line" | sed -E 's/`([^`]*(\{\{|\{%).*?)`/``\1``/g')
+        echo "$line" >> "$temp_file"
       else
-        # Outside code blocks, keep as is
+        # Outside code blocks and no inline code, keep as is
         echo "$line" >> "$temp_file"
       fi
     done < "$file"

.github/scripts/docs/fix-schema-links.sh

@@ -32,12 +32,12 @@ find "$BASE_DIR" -type f -name "*.md" | grep -v "node_modules" | while read file
   if [[ "$file" == *"/schemas/"* ]]; then
     if grep -q "^---" "$file" && ! grep -q "parent:" "$file" && [[ "$file" != *"/schemas/index.md" ]]; then
       sed "${SED_INPLACE[@]}" '/^layout:/a\
-parent: SCHEMA REFERENCE' "$file"
+parent: Schema Reference' "$file"
     fi
 
-    # Make case consistent in existing parent references (Schema Reference -> SCHEMA REFERENCE)
+    # Make case consistent in existing parent references (Schema Reference -> Schema Reference)
     if grep -q "parent: Schema Reference" "$file"; then
-      sed "${SED_INPLACE[@]}" 's/parent: Schema Reference/parent: SCHEMA REFERENCE/g' "$file"
+      sed "${SED_INPLACE[@]}" 's/parent: Schema Reference/parent: Schema Reference/g' "$file"
     fi
 
     # Fix common schema reference patterns
@@ -141,7 +141,7 @@ if [ ! -f "./SCHEMA_REFERENCE.md" ]; then
   cat > "./SCHEMA_REFERENCE.md" << EOF
 ---
 layout: default
-title: SCHEMA REFERENCE
+title: Schema Reference
 nav_order: 5
 has_children: true
 permalink: /schemas/
@@ -179,7 +179,7 @@ if [ -f "./schemas/README.md" ] && [ ! -f "./schemas/index.md" ]; then
   sed "${SED_INPLACE[@]}" '/^---/,/^---/d' "./schemas/index.md"
 
   # Add new front matter
-  front_matter="---\nlayout: default\ntitle: SCHEMA REFERENCE\nnav_order: 5\nhas_children: true\npermalink: /schemas/\n---\n\n"
+  front_matter="---\nlayout: default\ntitle: Schema Reference\nnav_order: 5\nhas_children: true\npermalink: /schemas/\n---\n\n"
   sed "${SED_INPLACE[@]}" "1s/^/$front_matter/" "./schemas/index.md"
 
   echo "✅ Created schemas/index.md with proper front matter"

.github/scripts/docs/process-docs.sh

@@ -134,10 +134,10 @@ else
     # Create a completely new file with proper front matter
     if [ "$is_core" = true ]; then
       # Core schema - visible in navigation
-      echo -e "---\nlayout: default\ntitle: \"$title\"\nparent: SCHEMA REFERENCE\n---\n\n$content" > "$file"
+      echo -e "---\nlayout: default\ntitle: \"$title\"\nparent: Schema Reference\n---\n\n$content" > "$file"
     else
       # Non-core schema - hidden from navigation
-      echo -e "---\nlayout: default\ntitle: \"$title\"\nparent: SCHEMA REFERENCE\nnav_exclude: true\n---\n\n$content" > "$file"
+      echo -e "---\nlayout: default\ntitle: \"$title\"\nparent: Schema Reference\nnav_exclude: true\n---\n\n$content" > "$file"
     fi
   done
 
@@ -167,10 +167,10 @@ else
 
       if [ "$is_core" = true ]; then
         # Core schema - visible in navigation
-        sed "${SED_INPLACE[@]}" "1s/^/---\nlayout: default\ntitle: \"$title\"\nparent: SCHEMA REFERENCE\n---\n\n/" "$file"
+        sed "${SED_INPLACE[@]}" "1s/^/---\nlayout: default\ntitle: \"$title\"\nparent: Schema Reference\n---\n\n/" "$file"
       else
         # Non-core schema - hidden from navigation
-        sed "${SED_INPLACE[@]}" "1s/^/---\nlayout: default\ntitle: \"$title\"\nparent: SCHEMA REFERENCE\nnav_exclude: true\n---\n\n/" "$file"
+        sed "${SED_INPLACE[@]}" "1s/^/---\nlayout: default\ntitle: \"$title\"\nparent: Schema Reference\nnav_exclude: true\n---\n\n/" "$file"
       fi
       continue
     fi
@@ -189,10 +189,10 @@ else
       # Add proper front matter with correct line breaks
       if [ "$is_core" = true ]; then
         # Core schema - visible in navigation
-        sed "${SED_INPLACE[@]}" "1s/^/---\nlayout: default\ntitle: \"$title\"\nparent: SCHEMA REFERENCE\n---\n\n/" "$file"
+        sed "${SED_INPLACE[@]}" "1s/^/---\nlayout: default\ntitle: \"$title\"\nparent: Schema Reference\n---\n\n/" "$file"
       else
         # Non-core schema - hidden from navigation
-        sed "${SED_INPLACE[@]}" "1s/^/---\nlayout: default\ntitle: \"$title\"\nparent: SCHEMA REFERENCE\nnav_exclude: true\n---\n\n/" "$file"
+        sed "${SED_INPLACE[@]}" "1s/^/---\nlayout: default\ntitle: \"$title\"\nparent: Schema Reference\nnav_exclude: true\n---\n\n/" "$file"
       fi
       continue
     fi
@@ -247,7 +247,7 @@ nav_exclude: true' "$file"
     cat > "$BASE_DIR/temp_schema_ref.md" << EOF
 ---
 layout: default
-title: SCHEMA REFERENCE
+title: Schema Reference
 nav_order: 5
 has_children: true
 permalink: /schemas/

docs/features/code-based/PAGE_VIEWS.md

@@ -19,4 +19,4 @@ The main template layout is `govuk-frontend`'s `template.njk` file, this also ne
 
 ## Using page views with data from your own API
 
-Page templates have access to `{{ context.data }}`, which is an attribute made available when a page event is triggered. It represents the entire response body from your API. To learn more about this, [see our guidance on page events](../configuration-based/PAGE_EVENTS.md).
+Page templates have access to `{{ context.data }}`, which is an attribute made available when a page event is triggered. It represents the entire response body from your API. To learn more about this, [see our guidance on page events](../configuration-based/PAGE_EVENTS.md).

docs/features/configuration-based/PAGE_EVENTS.md

@@ -11,7 +11,7 @@ Page events are a configuration-based way of triggering an action on an event tr
 
 DXT's forms engine is a frontend service, which should remain as lightweight as possible with business logic being implemented in a backend/BFF API. Using page events, DXT can call your API and use the tailored response downstream, such a page templates to display the response value.
 
-The downstream API response becomes available under the `{{ context.data }}` view model attribute for view templates, so it can be used when rendering a page. This attribute is directly accessible by our [page templates](./../configuration-based/PAGE_TEMPLATES.md) feature and our Nunjucks-based views.
+The downstream API response becomes available under the `{{ context.data }}` view model attribute for view templates, so it can be used when rendering a page. This attribute is directly accessible by our [page templates](./../configuration-based/PAGE_TEMPLATES.md) feature and our Nunjucks-based views.
 
 ## Architecture
 
@@ -115,10 +115,11 @@ Your API response:
 Page template:
 
 ```jinja2
-{% if context.data.awardedGrantValue %}
-  <p class="govuk-body">Congratulations. You are likely to receive up to £&#123;&#123; context.data.awardedGrantValue &#125;&#125;.</p>
-&#123;% endif %&#125;
+{% if context.data.awardedGrantValue %}
+  <p class="govuk-body">Congratulations. You are likely to receive up to £{{ context.data.awardedGrantValue }}.</p>
+{% endif %}
   <p class="govuk-body">You have not been awarded any funding for this application.</p>
+{% endif %}
 ```
 
 Results in:

docs/features/configuration-based/PAGE_TEMPLATES.md

@@ -61,7 +61,7 @@ The following elements support [LiquidJS templates](https://liquidjs.com/):
 ## Template data
 
 The data the templates are evaluated against is the raw answers the user has provided up to the page they're currently on.
-For example, given a YesNoField component called `TKsWbP`, the template `{{ TKsWbP }}` would render "true" or "false" depending on how the user answered the question.
+For example, given a YesNoField component called `TKsWbP`, the template `{{ TKsWbP }}` would render "true" or "false" depending on how the user answered the question.
 
 The current FormContext is also available as `context` in the templates. This allows access to the full data including the path the user has taken in their journey and any miscellaneous data returned from `Page event`s in `context.data`.
 
@@ -158,4 +158,4 @@ Whilst DXT offers some out of the box filters, teams using the plugin have the c
 
 ## Using page templates with data from your own API
 
-Page templates have access to`{{ context.data  }}` , which is an attribute made available when a page event is triggered. It represents the entire response body from your API. To learn more about this, [see our guidance on page events](./PAGE_EVENTS.md).
+Page templates have access to``{{ context.data  }}` , which is an attribute made available when a page event is triggered. It represents the entire response body from your API. To learn more about this, [see our guidance on page events](./PAGE_EVENTS.md).

scripts/generate-schema-docs.js

@@ -177,7 +177,7 @@ export function createIndexFile(schemaFiles) {
 
   const content = `---
 layout: default
-title: SCHEMA REFERENCE
+title: Schema Reference
 nav_order: 5
 has_children: true
 permalink: /schemas/

src/server/plugins/engine/README.md

@@ -18,7 +18,7 @@ The following elements support [LiquidJS templates](https://liquidjs.com/):
 ### Template data
 
 The data the templates are evaluated against is the raw answers the user has provided up to the page they're currently on.
-For example, given a YesNoField component called `TKsWbP`, the template `{{ TKsWbP }}` would render "true" or "false" depending on how the user answered the question.
+For example, given a YesNoField component called `TKsWbP`, the template `{{ TKsWbP }}` would render "true" or "false" depending on how the user answered the question.
 
 The current FormContext is also available as `context` in the templates. This allows access to the full data including the path the user has taken in their journey and any miscellaneous data returned from `Page event`s in `context.data`.