diff --git a/CLAUDE.md b/CLAUDE.md index 0e369787..a9199f5a 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -125,7 +125,7 @@ grep -r '/>' --include="*.mdx" --include="*.md" . ## Liquid API Reference -`api/openapi.json` generates the endpoint pages of the API reference tab. Never edit it by hand: it is exported from the console repository's endpoint registry (`apps/web/lib/api/docs.ts`) with `bun run openapi:export`. Change the endpoint docs there and re-export. See the README's "Liquid API Reference" section. +`api/openapi.json` generates the endpoint pages under API reference in the Hosted API tab. Never edit it by hand: it is exported from the console repository's endpoint registry (`apps/web/lib/api/docs.ts`) with `bun run openapi:export`. Change the endpoint docs there and re-export. See the README's "Liquid API Reference" section. ## Sidebar Navigation diff --git a/README.md b/README.md index 86a94b0e..67fe64dd 100644 --- a/README.md +++ b/README.md @@ -172,7 +172,7 @@ For more details on Mintlify setup and configuration, visit the [official Mintli ### Liquid API Reference -The **API** and **API reference** tabs document the hosted Liquid API served by Liquid Console. The endpoint pages under **API reference** are generated by Mintlify from [`api/openapi.json`](./api/openapi.json). Don't edit that file by hand: it is exported from the endpoint registry in the console repository (`apps/web/lib/api/docs.ts`). After an API change lands there, regenerate it from the console's `apps/web` directory and open a pull request here with the result: +The **Hosted API** tab documents the hosted Liquid API served by Liquid Console. The endpoint pages under **API reference** are generated by Mintlify from [`api/openapi.json`](./api/openapi.json). Don't edit that file by hand: it is exported from the endpoint registry in the console repository (`apps/web/lib/api/docs.ts`). After an API change lands there, regenerate it from the console's `apps/web` directory and open a pull request here with the result: ```bash bun run openapi:export /api/openapi.json diff --git a/docs.json b/docs.json index 3780cac9..24045f18 100644 --- a/docs.json +++ b/docs.json @@ -1,7 +1,7 @@ { "$schema": "https://mintlify.com/docs.json", "banner": { - "content": "🚀 New: LFM3 — text, vision, audio, omni, and decision models on one new backbone! [Learn more →](/lfm/models/complete-library)", + "content": "\ud83d\ude80 New: LFM3 \u2014 text, vision, audio, omni, and decision models on one new backbone! [Learn more \u2192](/lfm/models/complete-library)", "dismissible": true }, "theme": "mint", @@ -83,15 +83,14 @@ "navigation": { "tabs": [ { - "tab": "LFM", + "tab": "Models", "groups": [ { - "group": "LFM", + "group": "Models", "pages": [ { "group": "Models", "icon": "brain", - "expanded": false, "pages": [ { "group": "Liquid Foundation Models", @@ -113,24 +112,68 @@ "lfm/key-concepts/audio-capabilities", "lfm/key-concepts/omni-capabilities", "lfm/key-concepts/speculative-decoding" - ] + ], + "expanded": false }, + { + "group": "Guides", + "icon": "book-open", + "pages": [ + "guides/hardware-evaluation", + "guides/use-case-evaluation", + "guides/migration-guide", + "guides/decision-model-guide" + ], + "expanded": false + }, + { + "group": "Help", + "icon": "book", + "pages": [ + "lfm/help/faqs", + "lfm/help/troubleshooting", + "lfm/help/deprecations", + "lfm/help/contributing", + "lfm/help/connect-ai-tools", + "lfm/help/model-license" + ], + "expanded": false + } + ] + } + ] + }, + { + "tab": "Fine-tune", + "groups": [ + { + "group": "Fine-tune", + "pages": [ { "group": "Fine-tuning", "icon": "sliders", - "expanded": false, "pages": [ "lfm/fine-tuning/overview", "lfm/fine-tuning/liquid-finetune", "lfm/fine-tuning/datasets", "lfm/fine-tuning/trl", "lfm/fine-tuning/unsloth" - ] - }, + ], + "expanded": false + } + ] + } + ] + }, + { + "tab": "Deploy", + "groups": [ + { + "group": "Deploy", + "pages": [ { "group": "Edge Inference", "icon": "mobile", - "expanded": false, "pages": [ "deployment/on-device/llama-cpp", "deployment/on-device/llama-cpp/mobile", @@ -140,106 +183,80 @@ "deployment/on-device/ollama", "deployment/on-device/atomic-chat", "deployment/on-device/llama" - ] + ], + "expanded": false }, { "group": "GPU Inference", "icon": "microchip", - "expanded": false, "pages": [ "deployment/gpu-inference/transformers", "deployment/gpu-inference/sglang", "deployment/gpu-inference/vllm" - ] + ], + "expanded": false }, { "group": "Cloud Inference", "icon": "cloud", - "expanded": false, "pages": [ "deployment/gpu-inference/modal", "deployment/gpu-inference/baseten", "deployment/gpu-inference/fal" - ] - }, - { - "group": "Guides", - "icon": "book-open", - "expanded": false, - "pages": [ - "guides/hardware-evaluation", - "guides/use-case-evaluation", - "guides/migration-guide", - "guides/decision-model-guide" - ] + ], + "expanded": false }, { - "group": "Help", - "icon": "book", - "expanded": false, + "group": "Agents", + "icon": "robot", "pages": [ - "lfm/help/faqs", - "lfm/help/troubleshooting", - "lfm/help/deprecations", - "lfm/help/contributing", - "lfm/help/connect-ai-tools", - "lfm/help/model-license" - ] + "examples/agent-harnesses" + ], + "expanded": false } ] } ] }, { - "tab": "API", + "tab": "Hosted API", "groups": [ { - "group": "API", + "group": "Hosted API", "pages": [ { "group": "Get started", "icon": "rocket", - "expanded": false, "pages": [ "api/overview", "api/quickstart", "api/models" - ] + ], + "expanded": false }, { "group": "Capabilities", "icon": "wand-magic-sparkles", - "expanded": false, "pages": [ "api/guides/text-generation", "api/guides/vision", "api/guides/audio", "api/guides/decisions" - ] + ], + "expanded": false }, { "group": "Platform", "icon": "server", - "expanded": false, "pages": [ "api/guides/batch", "api/guides/your-data" - ] - } - ] - } - ] - }, - { - "tab": "API reference", - "groups": [ - { - "group": "API reference", - "pages": [ + ], + "expanded": false + }, { "group": "API reference", "icon": "code", - "expanded": false, "pages": [ "api/reference/overview", "api/reference/rate-limits", @@ -252,32 +269,30 @@ "directory": "api/reference" } } - ] + ], + "expanded": false } ] } ] }, { - "tab": "Examples", + "tab": "Tutorials", "groups": [ { - "group": "Examples", + "group": "Tutorials", "pages": [ { "group": "Getting Started", "icon": "rocket", - "expanded": false, "pages": [ - "examples/index", - "examples/connect-ai-tools", - "examples/agent-harnesses" - ] + "examples/index" + ], + "expanded": false }, { - "group": "Laptop Examples", + "group": "Laptop", "icon": "laptop", - "expanded": false, "pages": [ "examples/laptop-examples/invoice-extractor-tool-with-liquid-nanos", "examples/laptop-examples/build-a-game-with-decision-models", @@ -287,40 +302,41 @@ "examples/laptop-examples/audio-car-cockpit", "examples/laptop-examples/meeting-summarization", "examples/laptop-examples/browser-control" - ] + ], + "expanded": false }, { - "group": "Android Examples", + "group": "Android", "icon": "robot", - "expanded": false, "pages": [ "examples/android/slogan-generator", "examples/android/web-content-summarizer", "examples/android/recipe-generator-constrained-output", "examples/android/vision-language-model-example", "examples/android/leap-koog-agent" - ] + ], + "expanded": false }, { - "group": "Web Examples", + "group": "Web", "icon": "globe", - "expanded": false, "pages": [ "examples/web/vl-webgpu-demo", "examples/web/audio-webgpu-demo", "examples/web/hand-voice-racer" - ] + ], + "expanded": false }, { - "group": "Model Customization", + "group": "Fine-tuning", "icon": "sliders", - "expanded": false, "pages": [ "examples/customize-models/car-maker-identification", "examples/customize-models/home-assistant", "examples/customize-models/satellite-vlm", "examples/customize-models/wildfire-prevention" - ] + ], + "expanded": false } ] } @@ -345,6 +361,10 @@ "source": "/lfm/getting-started/connect-ai-tools", "destination": "/lfm/help/connect-ai-tools" }, + { + "source": "/examples/connect-ai-tools", + "destination": "/lfm/help/connect-ai-tools" + }, { "source": "/lfm/getting-started/model-license", "destination": "/lfm/help/model-license" diff --git a/examples/connect-ai-tools.mdx b/examples/connect-ai-tools.mdx deleted file mode 100644 index 819a7bdb..00000000 --- a/examples/connect-ai-tools.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Connect AI Tools" -description: "Connect your AI coding tools to Liquid Docs via MCP for live, queryable access to documentation" -canonical: "https://docs.liquid.ai/lfm/help/connect-ai-tools" ---- - -import ConnectAiTools from "/snippets/connect-ai-tools.mdx"; - - diff --git a/examples/index.mdx b/examples/index.mdx index e1f79922..ae873674 100644 --- a/examples/index.mdx +++ b/examples/index.mdx @@ -1,6 +1,6 @@ --- -title: "Examples Library" -description: "Browse example projects and tutorials built with Liquid AI LFM models across laptop, Android, web, and fine-tuning use cases." +title: "Tutorials" +description: "Step-by-step tutorials for building apps with Liquid AI LFM models across laptop, Android, web, and fine-tuning use cases." --- ## Laptop @@ -44,7 +44,7 @@ description: "Browse example projects and tutorials built with Liquid AI LFM mod ## Android -These Android examples were built with the LEAP SDK, which is now deprecated. For new apps, embed llama.cpp directly — see [iOS & Android](/deployment/on-device/llama-cpp/mobile). +These Android tutorials were built with the LEAP SDK, which is now deprecated. For new apps, embed llama.cpp directly — see [iOS & Android](/deployment/on-device/llama-cpp/mobile). @@ -111,12 +111,12 @@ These Android examples were built with the LEAP SDK, which is now deprecated. Fo -## Cannot find the example you need? +## Can't find the tutorial you need? - Connect with the community and let us know what examples you'd like to see. + Connect with the community and let us know what tutorials you'd like to see.