Skip to content

docs: architecture & feature diagrams (blueprint style)#10137

Merged
mudler merged 4 commits into
masterfrom
docs/architecture-diagrams
Jun 2, 2026
Merged

docs: architecture & feature diagrams (blueprint style)#10137
mudler merged 4 commits into
masterfrom
docs/architecture-diagrams

Conversation

@localai-bot

@localai-bot localai-bot commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator

Adds 25 blueprint-style diagrams across the docs (one architecture flagship + 24 feature/flow/comparison cards), committed under docs/static/images/diagrams/ as PNG + HTML source so they're editable later. Generated from an impact-vs-effort audit of all 79 docs pages. Follows #10136 (composable positioning).

All cards share LocalAI's existing blueprint / riso house style (paper + ink + rust + teal, Bricolage Grotesque + Archivo, hard offset shadows, engineering-grid).

What's included

  • Architecture flagship -> overview.md + replaces the stale external image on reference/architecture.md (clients incl. OpenAI/Anthropic/ElevenLabs/Ollama/LocalAI API -> small core -> gRPC -> on-demand backends)
  • Distributed: distributed-mode architecture, SmartRouter scheduling, ds4 layer-split, federated-vs-worker, MLX pipeline-parallel
  • Pipelines/flows: realtime voice, quantization, reranker, fine-tuning recipe + job lifecycle, diarization, model resolution, quickstart journey
  • Proxy/middleware: mitm intercept, cloud proxy, request-lifecycle middleware, reverse-proxy TLS
  • Capabilities: MCP server-vs-client, agents loop, function-call parsers, voice & face recognition, audio transform, VRAM eviction

Several also replace fragile external screenshots (link-rot risk) with real diagrams.

Built with a 24-agent parallel workflow; every card was reviewed against its render and wired into its docs page.

mudler added 2 commits June 2, 2026 15:45
Add a blueprint-style architecture diagram: clients -> small core (API,
router, WebUI, agents) -> gRPC -> backend processes pulled on demand as
OCI images. Place it on the overview page and replace the stale external
architecture image on the reference page.

Assisted-by: Claude:claude-opus-4-8 [Claude Code]
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>
…arted docs

Add 24 architecture/flow/comparison diagrams (PNG + HTML source) under
docs/static/images/diagrams/, wired into their docs pages, from an
impact-vs-effort audit of the docs. Broaden the API surface on the
overview architecture diagram (OpenAI, Anthropic, ElevenLabs, Ollama,
and LocalAI's own API) and move the gRPC boundary label clear of the arrows.

Pages: distributed mode (architecture, scheduling, ds4 layer-split),
distributed inferencing, MLX, realtime, quantization, MCP, agents,
mitm & cloud proxy, middleware, reverse-proxy TLS, VRAM, voice & face
recognition, reranker, function calling, fine-tuning (recipe + jobs),
diarization, audio transform, quickstart, model resolution.

Assisted-by: Claude:claude-opus-4-8 [Claude Code]
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>
@localai-bot localai-bot marked this pull request as ready for review June 2, 2026 16:28
mudler added 2 commits June 2, 2026 16:34
Commit the composable-core card (small core + on-demand backend tiles)
alongside the other diagrams and reference it from the README hero via a
repo-relative path, so it renders on GitHub.

Assisted-by: Claude:claude-opus-4-8 [Claude Code]
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>
…yout

- composable-core: thicken the plug-in connectors so they read clearly, and
  widen the SEPARATE IMAGE badge so its text no longer overflows the box.
- federated-vs-worker: shorten the WHOLE/SPLIT REQUEST pills to fit, and
  replace the tangled node-to-node activation arrows with a clean fan-out
  (request split across all sharded nodes), mirroring the federated panel.

Assisted-by: Claude:claude-opus-4-8 [Claude Code]
Signed-off-by: Ettore Di Giacinto <mudler@localai.io>
@mudler mudler merged commit 7e59a5c into master Jun 2, 2026
57 checks passed
@mudler mudler deleted the docs/architecture-diagrams branch June 2, 2026 16:43
@localai-bot localai-bot added the kind/documentation Improvements or additions to documentation label Jun 10, 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