Skip to content

Commit 26384c5

Browse files
authored
fix(docs): Use notice instead of alert (#9134)
Signed-off-by: Richard Palethorpe <io@richiejp.com>
1 parent 7209457 commit 26384c5

3 files changed

Lines changed: 5 additions & 4 deletions

File tree

.agents/coding-style.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,4 @@ The project documentation is located in `docs/content`. When adding new features
4949
- **Feature Documentation**: If you add a new feature (like a new backend or API endpoint), create a new markdown file in `docs/content/features/` explaining what it is, how to configure it, and how to use it.
5050
- **Configuration**: If you modify configuration options, update the relevant sections in `docs/content/`.
5151
- **Examples**: providing concrete examples (like YAML configuration blocks) is highly encouraged to help users get started quickly.
52+
- **Shortcodes**: Use `{{% notice note %}}`, `{{% notice tip %}}`, or `{{% notice warning %}}` for callout boxes. Do **not** use `{{% alert %}}` — that shortcode does not exist in this project's Hugo theme and will break the docs build.

docs/content/features/fine-tuning.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ LocalAI supports fine-tuning LLMs directly through the API and Web UI. Fine-tuni
1717

1818
Fine-tuning is always enabled. When authentication is enabled, fine-tuning is a per-user feature (default OFF). Admins can enable it for specific users via the user management API.
1919

20-
{{% alert note %}}
20+
{{% notice note %}}
2121
This feature is **experimental** and may change in future releases.
22-
{{% /alert %}}
22+
{{% /notice %}}
2323

2424
## Quick Start
2525

docs/content/features/quantization.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ url = '/features/quantization/'
77

88
LocalAI supports model quantization directly through the API and Web UI. Quantization converts HuggingFace models to GGUF format and compresses them to smaller sizes for efficient inference with llama.cpp.
99

10-
{{% alert note %}}
10+
{{% notice note %}}
1111
This feature is **experimental** and may change in future releases.
12-
{{% /alert %}}
12+
{{% /notice %}}
1313

1414
## Supported Backends
1515

0 commit comments

Comments
 (0)