From 40d35c0385df6015f839a89e4729b931be716db2 Mon Sep 17 00:00:00 2001 From: "mudler's LocalAI [bot]" <139863280+localai-bot@users.noreply.github.com> Date: Fri, 17 Jul 2026 22:08:20 +0200 Subject: [PATCH] docs: onboarding overhaul, dedup, and error docs (#7711) (#10895) * docs: fix CPU image tag (latest, not latest-cpu) Signed-off-by: Ettore Di Giacinto * docs: use canonical localai/localai registry in models guide Signed-off-by: Ettore Di Giacinto * docs: replace dead llama-stable backend with llama-cpp Signed-off-by: Ettore Di Giacinto * docs: correct mitm-proxy intercept config and redaction tier Signed-off-by: Ettore Di Giacinto * docs: fix text-to-audio endpoint and broken notice block Signed-off-by: Ettore Di Giacinto * docs: fix VAD example, stale FAQ, broken link, CLI list, whats-new dump Signed-off-by: Ettore Di Giacinto * docs: render advanced/reference section indexes (consolidate _index) Signed-off-by: Ettore Di Giacinto * docs: remove duplicate getting-started build/kubernetes pages Signed-off-by: Ettore Di Giacinto * docs: fold container image reference into installation/containers Signed-off-by: Ettore Di Giacinto * docs: remove stale advanced fine-tuning page (superseded by features/fine-tuning) Signed-off-by: Ettore Di Giacinto * docs: fold distribution/longcat/sound pages into their parents Signed-off-by: Ettore Di Giacinto * docs: make getting-started index accurate and complete Signed-off-by: Ettore Di Giacinto * docs: carry one concrete model through the getting-started path Signed-off-by: Ettore Di Giacinto * docs: add end-to-end 'build your first agent' walkthrough Signed-off-by: Ettore Di Giacinto * docs: add runtime errors reference; consolidate troubleshooting from FAQ Signed-off-by: Ettore Di Giacinto * docs: add agent actions catalog Signed-off-by: Ettore Di Giacinto * docs: agent-scoped MCP, skills walkthrough, agentic disambiguation Signed-off-by: Ettore Di Giacinto * docs: add concrete gallery install lines to media feature pages Signed-off-by: Ettore Di Giacinto * docs: merge installation into getting-started (URLs preserved via aliases) Signed-off-by: Ettore Di Giacinto * docs: add Operations section; move operator pages and P2P API reference Signed-off-by: Ettore Di Giacinto * docs: journey-ordered top nav and grouped feature sections Signed-off-by: Ettore Di Giacinto * docs: add docs-with-code process gate (PR template + agent instructions) Signed-off-by: Ettore Di Giacinto * docs: remove em/en dashes from documentation prose Signed-off-by: Ettore Di Giacinto --------- Signed-off-by: Ettore Di Giacinto Co-authored-by: Ettore Di Giacinto --- .agents/coding-style.md | 1 + .github/PULL_REQUEST_TEMPLATE.md | 1 + AGENTS.md | 2 +- docs/content/_index.md | 4 +- docs/content/advanced/_index.en.md | 105 +++- docs/content/advanced/_index.md | 126 ----- docs/content/advanced/advanced-usage.md | 4 +- docs/content/advanced/fine-tuning.md | 126 ----- docs/content/advanced/model-configuration.md | 28 +- docs/content/advanced/vram-management.md | 16 +- docs/content/faq.md | 32 +- docs/content/features/GPU-acceleration.md | 6 +- docs/content/features/_index.en.md | 90 ++-- docs/content/features/agent-actions.md | 129 +++++ docs/content/features/agents.md | 115 ++++- docs/content/features/api-discovery.md | 14 +- docs/content/features/audio-classification.md | 14 +- docs/content/features/audio-diarization.md | 30 +- docs/content/features/audio-to-text.md | 12 +- docs/content/features/audio-transform.md | 30 +- docs/content/features/authentication.md | 28 +- docs/content/features/backends.md | 4 +- docs/content/features/constrained_grammars.md | 2 +- docs/content/features/distributed-mode.md | 38 +- .../features/distributed_inferencing.md | 15 +- docs/content/features/distribution.md | 34 -- docs/content/features/embeddings.md | 4 +- docs/content/features/face-recognition.md | 32 +- docs/content/features/fine-tuning.md | 21 +- docs/content/features/gpt-vision.md | 20 +- docs/content/features/image-generation.md | 4 +- docs/content/features/interleaved-thinking.md | 2 +- docs/content/features/localai-assistant.md | 18 +- docs/content/features/longcat-video.md | 169 ------- docs/content/features/mcp.md | 25 +- docs/content/features/mlx-distributed.md | 18 +- docs/content/features/model-aliases.md | 4 +- docs/content/features/model-gallery.md | 2 +- docs/content/features/object-detection.md | 8 +- docs/content/features/openai-functions.md | 18 +- docs/content/features/openai-realtime.md | 34 +- docs/content/features/quantization.md | 10 +- docs/content/features/reranker.md | 2 +- docs/content/features/runtime-settings.md | 2 +- docs/content/features/sound-generation.md | 104 ---- docs/content/features/stores.md | 4 +- docs/content/features/text-generation.md | 28 +- docs/content/features/text-to-audio.md | 53 +- docs/content/features/video-generation.md | 176 ++++++- .../features/voice-activity-detection.md | 35 +- docs/content/features/voice-recognition.md | 30 +- docs/content/getting-started/_index.en.md | 21 +- docs/content/getting-started/build.md | 183 ++++++- .../getting-started/container-images.md | 126 ----- .../containers.md | 99 +++- .../getting-started/customize-model.md | 2 +- .../docker.md | 2 +- docs/content/getting-started/first-agent.md | 70 +++ docs/content/getting-started/install.md | 43 ++ docs/content/getting-started/kubernetes.md | 2 +- .../linux.md | 19 +- .../macos.md | 2 +- docs/content/getting-started/models.md | 14 +- docs/content/getting-started/quickstart.md | 33 +- .../getting-started/troubleshooting.md | 6 +- docs/content/getting-started/try-it-out.md | 18 +- docs/content/installation/_index.en.md | 43 -- docs/content/installation/build.md | 183 ------- docs/content/installation/kubernetes.md | 31 -- docs/content/integrations.md | 56 +-- docs/content/operations/_index.en.md | 16 + .../backend-monitor.md | 0 .../{features => operations}/cloud-proxy.md | 19 +- .../{features => operations}/middleware.md | 109 ++-- .../{features => operations}/mitm-proxy.md | 51 +- docs/content/overview.md | 22 +- docs/content/reference/_index.en.md | 170 ++++++- docs/content/reference/_index.md | 178 ------- .../content/reference/ai-coding-assistants.md | 12 +- docs/content/reference/api-errors.md | 44 +- docs/content/reference/architecture.md | 2 +- docs/content/reference/cli-reference.md | 10 +- docs/content/reference/nvidia-l4t.md | 2 +- .../{features/p2p.md => reference/p2p-api.md} | 2 +- docs/content/reference/runtime-errors.md | 63 +++ docs/content/whats-new.md | 464 +----------------- 86 files changed, 1832 insertions(+), 2114 deletions(-) delete mode 100644 docs/content/advanced/_index.md delete mode 100644 docs/content/advanced/fine-tuning.md create mode 100644 docs/content/features/agent-actions.md delete mode 100644 docs/content/features/distribution.md delete mode 100644 docs/content/features/longcat-video.md delete mode 100644 docs/content/features/sound-generation.md delete mode 100644 docs/content/getting-started/container-images.md rename docs/content/{installation => getting-started}/containers.md (64%) rename docs/content/{installation => getting-started}/docker.md (96%) create mode 100644 docs/content/getting-started/first-agent.md create mode 100644 docs/content/getting-started/install.md rename docs/content/{installation => getting-started}/linux.md (70%) rename docs/content/{installation => getting-started}/macos.md (99%) delete mode 100644 docs/content/installation/_index.en.md delete mode 100644 docs/content/installation/build.md delete mode 100644 docs/content/installation/kubernetes.md create mode 100644 docs/content/operations/_index.en.md rename docs/content/{features => operations}/backend-monitor.md (100%) rename docs/content/{features => operations}/cloud-proxy.md (92%) rename docs/content/{features => operations}/middleware.md (87%) rename docs/content/{features => operations}/mitm-proxy.md (80%) delete mode 100644 docs/content/reference/_index.md rename docs/content/{features/p2p.md => reference/p2p-api.md} (99%) create mode 100644 docs/content/reference/runtime-errors.md diff --git a/.agents/coding-style.md b/.agents/coding-style.md index da10c61f0..ddee45ae2 100644 --- a/.agents/coding-style.md +++ b/.agents/coding-style.md @@ -65,6 +65,7 @@ This is enforced by `forbidigo` (see `.golangci.yml`): `http.DefaultClient` and The project documentation is located in `docs/content`. When adding new features or changing existing functionality, it is crucial to update the documentation to reflect these changes. This helps users understand how to use the new capabilities and ensures the documentation stays relevant. +- **Docs-with-code rule**: When you change user-facing behavior (API endpoints, CLI flags, config keys, or features), update the corresponding page under `docs/content/` in the SAME change, not as a follow-up. A user-facing change without a matching docs update is incomplete. The PR template carries a checklist item for this. - **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. - **Configuration**: If you modify configuration options, update the relevant sections in `docs/content/`. - **Examples**: providing concrete examples (like YAML configuration blocks) is highly encouraged to help users get started quickly. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ec5e354c5..6d0e30e7a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,6 +7,7 @@ This PR fixes # **[Signed commits](../CONTRIBUTING.md#signing-off-on-commits-developer-certificate-of-origin)** - [ ] Yes, I signed my commits. +- [ ] Documentation updated (docs/content/) for user-facing changes, or not applicable