Skip to content

Reorganize docs navigation and move API reference into Hosted API #169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ovenmitt wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Reorganize docs navigation and move API reference into Hosted API #169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
10c6b7c
Merge API reference into the Hosted API tab
ovenmitt Nov 7, 2026
a5fc26c
Split the LFM tab into Models, Fine-tune, and Deploy
ovenmitt Nov 7, 2026
01eeb0f
Rename the Examples tab to Tutorials
ovenmitt Nov 7, 2026
57d6517
Move agent harnesses to Deploy, redirect duplicate Connect AI Tools
ovenmitt Nov 7, 2026
848fda6
Update README and CLAUDE.md for the Hosted API tab
ovenmitt Nov 7, 2026
bac29e6
Merge remote-tracking branch 'origin/main' into ovenmitt/tabs-api-ren…
ovenmitt Nov 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <path to this repo>/api/openapi.json
Expand Down
170 changes: 95 additions & 75 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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",
Expand Down Expand Up @@ -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",
Expand All @@ -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",
Expand All @@ -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",
Expand All @@ -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",
Expand All @@ -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
}
]
}
Expand All @@ -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"
Expand Down
9 changes: 0 additions & 9 deletions examples/connect-ai-tools.mdx
View file
Open in desktop

This file was deleted.

10 changes: 5 additions & 5 deletions examples/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -44,7 +44,7 @@
## Android

<Note>
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).
</Note>

<CardGroup cols={2}>
Expand All @@ -62,11 +62,11 @@
</Card>

<Card title="Vision Language Model Demo" icon="eye" href="/examples/android/vision-language-model-example">
Analyze images and answer visual questions on Android using Vision Language Models. Built with Jetpack Compose and Coil.

Check warning on line 65 in examples/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (liquidai) - vale-spellcheck

examples/index.mdx#L65 

Did you really mean 'Jetpack'?
</Card>

<Card title="AI Agents with Koog" icon="robot" href="/examples/android/leap-koog-agent">
Build intelligent AI agents on Android with the Koog framework. Demonstrates tool invocation, context management, and MCP integration.

Check warning on line 69 in examples/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (liquidai) - vale-spellcheck

examples/index.mdx#L69 

Did you really mean 'Koog'?
</Card>

</CardGroup>
Expand Down Expand Up @@ -111,12 +111,12 @@

</CardGroup>

## Cannot find the example you need?
## Can't find the tutorial you need?

<CardGroup cols={1}>

<Card title="Join our Discord" icon="discord" iconType="brands" href="https://discord.gg/DFU3WQeaYD">
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.
</Card>

</CardGroup>
Loading