From 199fe89cfe02c337941f61d648e775c390e2f797 Mon Sep 17 00:00:00 2001 From: "LocalAI [bot]" <139863280+localai-bot@users.noreply.github.com> Date: Tue, 10 Mar 2026 07:34:44 +0100 Subject: [PATCH] feat: Expand section index pages with comprehensive navigation (M7) (#8929) feat: expand section index pages with comprehensive navigation (M7) Co-authored-by: localai-bot --- docs/content/advanced/_index.md | 126 ++++++++++++++++++++++++ docs/content/reference/_index.md | 164 +++++++++++++++++++++++++++++++ 2 files changed, 290 insertions(+) create mode 100644 docs/content/advanced/_index.md create mode 100644 docs/content/reference/_index.md diff --git a/docs/content/advanced/_index.md b/docs/content/advanced/_index.md new file mode 100644 index 000000000..afc617a8f --- /dev/null +++ b/docs/content/advanced/_index.md @@ -0,0 +1,126 @@ +--- +weight: 20 +title: "Advanced" +description: "Advanced usage and configuration" +type: chapter +icon: settings +lead: "Deep dive into LocalAI's advanced features, configuration options, and optimization techniques." +date: 2020-10-06T08:49:15+00:00 +lastmod: 2026-03-09T00:00:00+00:00 +draft: false +images: [] +--- + +## Overview + +The **Advanced** section covers in-depth topics for users who want to fully leverage LocalAI's capabilities beyond basic usage. These pages are designed for developers, DevOps engineers, and power users who need fine-grained control over model configuration, system resources, and deployment infrastructure. + +### Who Should Read This Section + +- **Developers** integrating LocalAI into applications +- **DevOps Engineers** deploying LocalAI in production +- **ML Engineers** optimizing model performance +- **System Administrators** managing multi-user installations + +--- + +## Topics + +### 🚀 [Advanced Usage](advanced-usage.md) +Comprehensive guide to advanced LocalAI features including multi-modal inference, custom backends, and extended API capabilities. + +**Key topics:** +- Multi-modal model support +- Custom backend integration +- Advanced API endpoints +- Request/response customization + +**Recommended for:** Developers extending LocalAI functionality + +--- + +### 🎯 [Model Configuration](model-configuration.md) +Complete reference for model configuration files, parameters, and optimization settings. + +**Key topics:** +- Configuration file format +- Model-specific parameters +- Quantization settings +- Performance tuning + +**Recommended for:** ML engineers optimizing model behavior + +--- + +### 🔧 [Fine-Tuning](fine-tuning.md) +Guide to fine-tuning models with LocalAI for domain-specific applications. + +**Key topics:** +- Training data preparation +- Fine-tuning parameters +- Evaluation metrics +- Best practices + +**Recommended for:** Users creating specialized models + +--- + +### 🔒 [Reverse Proxy & TLS](reverse-proxy-tls.md) +Complete guide to securing LocalAI deployments with reverse proxies and TLS certificates. + +**Key topics:** +- Nginx/Apache configuration +- TLS certificate setup +- Authentication layers +- Production hardening + +**Recommended for:** DevOps engineers deploying to production + +--- + +### 💾 [VRAM Management](vram-management.md) +Advanced techniques for managing GPU memory and optimizing parallel inference. + +**Key topics:** +- GPU memory allocation +- Multi-model loading +- Batch processing +- Resource scheduling + +**Recommended for:** Users running multiple models on limited hardware + +--- + +## Quick Links + +| Task | Documentation | +|------|---------------| +| Configure a model | [Model Configuration](model-configuration.md) | +| Deploy securely | [Reverse Proxy & TLS](reverse-proxy-tls.md) | +| Optimize VRAM usage | [VRAM Management](vram-management.md) | +| Extend functionality | [Advanced Usage](advanced-usage.md) | + +--- + +## Prerequisites + +Before diving into advanced topics, ensure you have: + +1. ✅ Completed the [Getting Started](../getting-started/) guide +2. ✅ Successfully run LocalAI with a basic model +3. ✅ Basic understanding of command-line interfaces +4. ✅ Familiarity with YAML configuration (for most topics) + +--- + +## Related Sections + +- 📚 [Reference](../reference/) - API documentation and command reference +- 🔌 [Installation](../installation/) - Deployment options and requirements +- ⭐ [Features](../features/) - Overview of LocalAI capabilities + +--- + +## Navigation + +← [Getting Started](../getting-started/) | [Reference](../reference/) → diff --git a/docs/content/reference/_index.md b/docs/content/reference/_index.md new file mode 100644 index 000000000..efc16d9e5 --- /dev/null +++ b/docs/content/reference/_index.md @@ -0,0 +1,164 @@ +--- +weight: 23 +title: "References" +description: "Complete reference documentation" +type: chapter +icon: menu_book +lead: "API documentation, command reference, and technical specifications." +date: 2020-10-06T08:49:15+00:00 +lastmod: 2026-03-09T00:00:00+00:00 +draft: false +images: [] +--- + +## Overview + +The **References** section provides comprehensive technical documentation for developers and system administrators working with LocalAI. This includes API specifications, command-line reference, architecture details, and compatibility information. + +### Who Should Read This Section + +- **API Developers** integrating LocalAI into applications +- **System Administrators** configuring and maintaining installations +- **DevOps Engineers** understanding architecture and deployment +- **Troubleshooters** diagnosing issues and errors + +--- + +## Topics + +### 🔌 [API Errors](api-errors.md) +Complete reference of all API error codes, messages, and troubleshooting guidance. + +**Key topics:** +- Error code enumeration +- Error message formats +- Common error scenarios +- Resolution strategies + +**Recommended for:** Developers handling API responses and errors + +--- + +### 🏗️ [Architecture](architecture.md) +Overview of LocalAI's system architecture, components, and data flow. + +**Key topics:** +- System components +- Data flow diagrams +- Component interactions +- Design principles + +**Recommended for:** System architects and advanced users + +--- + +### 📦 [Binaries](binaries.md) +Reference documentation for LocalAI binary files and their purposes. + +**Key topics:** +- Binary file descriptions +- Usage instructions +- File locations +- Version information + +**Recommended for:** Users understanding installation structure + +--- + +### 💻 [CLI Reference](cli-reference.md) +Complete command-line interface reference with all commands, flags, and examples. + +**Key topics:** +- Command enumeration +- Flag documentation +- Usage examples +- Environment variables + +**Recommended for:** Command-line users and script developers + +--- + +### 🔄 [Compatibility Table](compatibility-table.md) +Comprehensive compatibility matrix for models, backends, and platforms. + +**Key topics:** +- Model compatibility +- Backend support matrix +- Platform requirements +- Version compatibility + +**Recommended for:** Users selecting models and configurations + +--- + +### 🎮 [NVIDIA L4T](nvidia-l4t.md) +Documentation for NVIDIA Linux for Tegra (L4T) platform support. + +**Key topics:** +- L4T platform requirements +- Installation procedures +- Configuration options +- Known issues + +**Recommended for:** NVIDIA Jetson/Tegra users + +--- + +### 🔤 [Shell Completion](shell-completion.md) +Guide to enabling shell completion for LocalAI CLI commands. + +**Key topics:** +- Bash completion setup +- Zsh completion setup +- Fish completion setup +- Customization options + +**Recommended for:** Command-line power users + +--- + +### 📊 [System Info](system-info.md) +Reference for system information commands and diagnostics. + +**Key topics:** +- System info commands +- Diagnostic output +- Hardware detection +- Performance metrics + +**Recommended for:** System administrators and troubleshooters + +--- + +## Quick Links + +| Task | Documentation | +|------|---------------| +| API integration | [API Errors](api-errors.md) | +| CLI commands | [CLI Reference](cli-reference.md) | +| Check compatibility | [Compatibility Table](compatibility-table.md) | +| System diagnostics | [System Info](system-info.md) | + +--- + +## Prerequisites + +Before using reference documentation, ensure you have: + +1. ✅ LocalAI installed and running +2. ✅ Basic understanding of APIs and command-line interfaces +3. ✅ Familiarity with your target platform (Linux, macOS, Windows) + +--- + +## Related Sections + +- 📖 [Advanced](../advanced/) - Deep dive into configuration and optimization +- 🔌 [Installation](../installation/) - Setup and deployment +- ⭐ [Features](../features/) - Feature overview + +--- + +## Navigation + +← [Advanced](../advanced/) | [FAQ](../faq.md) →