Skip to content

Commit 199fe89

Browse files
localai-botlocalai-bot
localai-bot
and
localai-bot
authored
feat: Expand section index pages with comprehensive navigation (M7) (#8929)
feat: expand section index pages with comprehensive navigation (M7) Co-authored-by: localai-bot <localai-bot@noreply.github.com>
1 parent de55ff3 commit 199fe89

2 files changed

Lines changed: 290 additions & 0 deletions

File tree

‎docs/content/advanced/_index.md‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
---
2+
weight: 20
3+
title: "Advanced"
4+
description: "Advanced usage and configuration"
5+
type: chapter
6+
icon: settings
7+
lead: "Deep dive into LocalAI's advanced features, configuration options, and optimization techniques."
8+
date: 2020-10-06T08:49:15+00:00
9+
lastmod: 2026-03-09T00:00:00+00:00
10+
draft: false
11+
images: []
12+
---
13+
14+
## Overview
15+
16+
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.
17+
18+
### Who Should Read This Section
19+
20+
- **Developers** integrating LocalAI into applications
21+
- **DevOps Engineers** deploying LocalAI in production
22+
- **ML Engineers** optimizing model performance
23+
- **System Administrators** managing multi-user installations
24+
25+
---
26+
27+
## Topics
28+
29+
### 🚀 [Advanced Usage](advanced-usage.md)
30+
Comprehensive guide to advanced LocalAI features including multi-modal inference, custom backends, and extended API capabilities.
31+
32+
**Key topics:**
33+
- Multi-modal model support
34+
- Custom backend integration
35+
- Advanced API endpoints
36+
- Request/response customization
37+
38+
**Recommended for:** Developers extending LocalAI functionality
39+
40+
---
41+
42+
### 🎯 [Model Configuration](model-configuration.md)
43+
Complete reference for model configuration files, parameters, and optimization settings.
44+
45+
**Key topics:**
46+
- Configuration file format
47+
- Model-specific parameters
48+
- Quantization settings
49+
- Performance tuning
50+
51+
**Recommended for:** ML engineers optimizing model behavior
52+
53+
---
54+
55+
### 🔧 [Fine-Tuning](fine-tuning.md)
56+
Guide to fine-tuning models with LocalAI for domain-specific applications.
57+
58+
**Key topics:**
59+
- Training data preparation
60+
- Fine-tuning parameters
61+
- Evaluation metrics
62+
- Best practices
63+
64+
**Recommended for:** Users creating specialized models
65+
66+
---
67+
68+
### 🔒 [Reverse Proxy & TLS](reverse-proxy-tls.md)
69+
Complete guide to securing LocalAI deployments with reverse proxies and TLS certificates.
70+
71+
**Key topics:**
72+
- Nginx/Apache configuration
73+
- TLS certificate setup
74+
- Authentication layers
75+
- Production hardening
76+
77+
**Recommended for:** DevOps engineers deploying to production
78+
79+
---
80+
81+
### 💾 [VRAM Management](vram-management.md)
82+
Advanced techniques for managing GPU memory and optimizing parallel inference.
83+
84+
**Key topics:**
85+
- GPU memory allocation
86+
- Multi-model loading
87+
- Batch processing
88+
- Resource scheduling
89+
90+
**Recommended for:** Users running multiple models on limited hardware
91+
92+
---
93+
94+
## Quick Links
95+
96+
| Task | Documentation |
97+
|------|---------------|
98+
| Configure a model | [Model Configuration](model-configuration.md) |
99+
| Deploy securely | [Reverse Proxy & TLS](reverse-proxy-tls.md) |
100+
| Optimize VRAM usage | [VRAM Management](vram-management.md) |
101+
| Extend functionality | [Advanced Usage](advanced-usage.md) |
102+
103+
---
104+
105+
## Prerequisites
106+
107+
Before diving into advanced topics, ensure you have:
108+
109+
1. ✅ Completed the [Getting Started](../getting-started/) guide
110+
2. ✅ Successfully run LocalAI with a basic model
111+
3. ✅ Basic understanding of command-line interfaces
112+
4. ✅ Familiarity with YAML configuration (for most topics)
113+
114+
---
115+
116+
## Related Sections
117+
118+
- 📚 [Reference](../reference/) - API documentation and command reference
119+
- 🔌 [Installation](../installation/) - Deployment options and requirements
120+
- ⭐ [Features](../features/) - Overview of LocalAI capabilities
121+
122+
---
123+
124+
## Navigation
125+
126+
← [Getting Started](../getting-started/) | [Reference](../reference/) →

‎docs/content/reference/_index.md‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
---
2+
weight: 23
3+
title: "References"
4+
description: "Complete reference documentation"
5+
type: chapter
6+
icon: menu_book
7+
lead: "API documentation, command reference, and technical specifications."
8+
date: 2020-10-06T08:49:15+00:00
9+
lastmod: 2026-03-09T00:00:00+00:00
10+
draft: false
11+
images: []
12+
---
13+
14+
## Overview
15+
16+
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.
17+
18+
### Who Should Read This Section
19+
20+
- **API Developers** integrating LocalAI into applications
21+
- **System Administrators** configuring and maintaining installations
22+
- **DevOps Engineers** understanding architecture and deployment
23+
- **Troubleshooters** diagnosing issues and errors
24+
25+
---
26+
27+
## Topics
28+
29+
### 🔌 [API Errors](api-errors.md)
30+
Complete reference of all API error codes, messages, and troubleshooting guidance.
31+
32+
**Key topics:**
33+
- Error code enumeration
34+
- Error message formats
35+
- Common error scenarios
36+
- Resolution strategies
37+
38+
**Recommended for:** Developers handling API responses and errors
39+
40+
---
41+
42+
### 🏗️ [Architecture](architecture.md)
43+
Overview of LocalAI's system architecture, components, and data flow.
44+
45+
**Key topics:**
46+
- System components
47+
- Data flow diagrams
48+
- Component interactions
49+
- Design principles
50+
51+
**Recommended for:** System architects and advanced users
52+
53+
---
54+
55+
### 📦 [Binaries](binaries.md)
56+
Reference documentation for LocalAI binary files and their purposes.
57+
58+
**Key topics:**
59+
- Binary file descriptions
60+
- Usage instructions
61+
- File locations
62+
- Version information
63+
64+
**Recommended for:** Users understanding installation structure
65+
66+
---
67+
68+
### 💻 [CLI Reference](cli-reference.md)
69+
Complete command-line interface reference with all commands, flags, and examples.
70+
71+
**Key topics:**
72+
- Command enumeration
73+
- Flag documentation
74+
- Usage examples
75+
- Environment variables
76+
77+
**Recommended for:** Command-line users and script developers
78+
79+
---
80+
81+
### 🔄 [Compatibility Table](compatibility-table.md)
82+
Comprehensive compatibility matrix for models, backends, and platforms.
83+
84+
**Key topics:**
85+
- Model compatibility
86+
- Backend support matrix
87+
- Platform requirements
88+
- Version compatibility
89+
90+
**Recommended for:** Users selecting models and configurations
91+
92+
---
93+
94+
### 🎮 [NVIDIA L4T](nvidia-l4t.md)
95+
Documentation for NVIDIA Linux for Tegra (L4T) platform support.
96+
97+
**Key topics:**
98+
- L4T platform requirements
99+
- Installation procedures
100+
- Configuration options
101+
- Known issues
102+
103+
**Recommended for:** NVIDIA Jetson/Tegra users
104+
105+
---
106+
107+
### 🔤 [Shell Completion](shell-completion.md)
108+
Guide to enabling shell completion for LocalAI CLI commands.
109+
110+
**Key topics:**
111+
- Bash completion setup
112+
- Zsh completion setup
113+
- Fish completion setup
114+
- Customization options
115+
116+
**Recommended for:** Command-line power users
117+
118+
---
119+
120+
### 📊 [System Info](system-info.md)
121+
Reference for system information commands and diagnostics.
122+
123+
**Key topics:**
124+
- System info commands
125+
- Diagnostic output
126+
- Hardware detection
127+
- Performance metrics
128+
129+
**Recommended for:** System administrators and troubleshooters
130+
131+
---
132+
133+
## Quick Links
134+
135+
| Task | Documentation |
136+
|------|---------------|
137+
| API integration | [API Errors](api-errors.md) |
138+
| CLI commands | [CLI Reference](cli-reference.md) |
139+
| Check compatibility | [Compatibility Table](compatibility-table.md) |
140+
| System diagnostics | [System Info](system-info.md) |
141+
142+
---
143+
144+
## Prerequisites
145+
146+
Before using reference documentation, ensure you have:
147+
148+
1. ✅ LocalAI installed and running
149+
2. ✅ Basic understanding of APIs and command-line interfaces
150+
3. ✅ Familiarity with your target platform (Linux, macOS, Windows)
151+
152+
---
153+
154+
## Related Sections
155+
156+
- 📖 [Advanced](../advanced/) - Deep dive into configuration and optimization
157+
- 🔌 [Installation](../installation/) - Setup and deployment
158+
- ⭐ [Features](../features/) - Feature overview
159+
160+
---
161+
162+
## Navigation
163+
164+
← [Advanced](../advanced/) | [FAQ](../faq.md) →

0 commit comments

Comments
 (0)