Skip to content

fix(docs): use relearn notice shortcode instead of unsupported alert - #10364

Merged
mudler merged 1 commit into
masterfrom
fix/docs-alert-shortcode
Jun 16, 2026
Merged

fix(docs): use relearn notice shortcode instead of unsupported alert#10364
mudler merged 1 commit into
masterfrom
fix/docs-alert-shortcode

Conversation

@localai-bot

Copy link
Copy Markdown
Collaborator

What

The docs deploy (GitHub Pages) is failing on master at the Build site step:

Error: error building site: ... failed to extract shortcode:
template for shortcode "alert" not found
docs/content/features/image-generation.md:106:1

Failing run: https://github.com/mudler/LocalAI/actions/runs/27624864370/job/81683555291

Why

The Hugo theme in use is hugo-theme-relearn, which has no alert shortcode. Callouts everywhere else in the docs use the theme-supported notice shortcode (48 occurrences). A recently added vae_decode_only note in image-generation.md used {{% alert note %}}, which Hugo cannot resolve, breaking the build.

Fix

Convert the block from alert to notice:

-{{% alert note %}}
+{{% notice note %}}
 `vae_decode_only` is still accepted for backwards compatibility ...
-{{% /alert %}}
+{{% /notice %}}

This is the only remaining alert occurrence in docs/content.

The Hugo relearn theme does not provide an "alert" shortcode, so the
docs deploy failed at the Build site step:

  failed to extract shortcode: template for shortcode "alert" not found
  docs/content/features/image-generation.md:106

Convert the vae_decode_only note to the theme-supported notice shortcode
used everywhere else in the docs.

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>
@mudler
mudler merged commit a6e1c6d into master Jun 16, 2026
56 of 57 checks passed
@mudler
mudler deleted the fix/docs-alert-shortcode branch June 16, 2026 19:06
@localai-bot localai-bot added the kind/documentation Improvements or additions to documentation label Jun 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants