Skip to content

Docs audit: discovery, assistant guidance, and LFM3 recommendations - #172

Merged
alay2shah merged 20 commits into
mainfrom
docs-audit
Nov 13, 2026
Merged

alay2shah merged 20 commits into
mainfrom
docs-audit

Conversation

@iamleonie

@iamleonie iamleonie commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Model pages outside the navigation were missing from search and assistant results, and general recommendations still led with older models. This audit makes model documentation discoverable and puts LFM3 first in general guidance while retaining useful older models.

  • Search and indexing: enable indexing for all pages; retain deprecated model and tool references with warnings. Exclude docs-maintainer files through .mintignore and mark the contributing page noindex.
  • Assistant: remove the CSS rule that hid the legacy assistant entry. Add instructions to cite measured performance, use Pipette, follow exact model-page format links for verified download sizes, and use published evaluation sources without inventing repositories or scores.
  • LFM3 guidance: update the FAQ, use-case evaluation, migration guide, and troubleshooting. Compare LFM3, LFM2.5, and LFM2; lead with LFM3 text, vision, audio, and omni models; retain smaller, specialized, and larger MoE alternatives with explicit reasons.
  • Version-specific instructions: distinguish LFM3 XML tool calls and qwen3_coder parsing from LFM2/LFM2.5 formats and lfm2 parsing. Scope chat templates, LoRA module examples, generation settings, and context limits to the selected model.
  • Deprecations and examples: point LFM2-2.6B, LFM2-2.6B-Exp, and LFM2-Audio directly to current replacements in notices, metadata, and the deprecations table. Add missing notices to four audio examples, a newer-model note to the invoice extractor, and warnings to archived bundling references.
  • Formats and quickstarts: expose the verified LFM3-Audio and LFM3-Omni ONNX repositories on their model pages and in the matrix. Organize ColBERT quickstarts into Retrieval and Reranking, with library/runtime choices inside Reranking; match the embedding page's “Sentence Transformers” label.
  • Other audit fixes: add eight legacy/mistyped URL redirects, improve embeddings/reranking/RAG terminology, make internal example links root-relative, and correct the Ollama model-name typo.

Validation

  • Mintlify build validation passed.
  • GitHub Check docs and Check link snapshot passed on 1b21fbe.
  • Updated preview content verified for the FAQ, evaluation and migration guides, troubleshooting, deprecation notice, and ONNX model buttons/matrix.
  • Link snapshot: 233 active URLs verified.
  • All 89 distinct internal links and snippet imports in the latest 11 changed files resolve; 20 Python snippets parse.
  • New Audio and Omni ONNX repositories verified against their official Hugging Face pages.
  • Updated deprecation notices resolve directly to models that are not deprecated.

Removing the assistant CSS restriction does not establish that Mintlify has enabled chat permissions; project configuration still controls assistant availability.

Preview review

Related work

A three-way check against #179 found two small conflicts in guides/migration-guide.mdx: the shared tool-call snippet import and component invocation. When integrating #179, preserve this PR's LFM3 guidance, adopt its LFM25ToolCallExample name with paired JSX tags, and keep the unused ChatMLExample import removed.

Model pages such as LFM3-1.7B are not in the docs.json navigation, so
Mintlify left them out of site search and the docs assistant. In the last
90 days, no assistant answer cited an individual model page. Setting
seo.indexing to "all" includes them. Pages with noindex: true stay
excluded.
The box was hidden in #148, leaving Cmd/Ctrl+I as the only way to open
the assistant on desktop. Users don't know the shortcut, so restore the
visible entry point.
The context-length FAQ now names LFM3-1.7B and LFM3-VL-2B instead of
the deprecated LFM2.5-2.6B. The two examples built on LFM2.5-Audio-1.5B
get a note pointing to LFM3-Audio-2B. Absolute docs.liquid.ai links in
examples are now root-relative.
Add 8 redirects for URLs that don't resolve but get real visitors,
including links from Hugging Face and external articles to pages
removed in earlier restructures.
Point speed, memory and device questions to Pipette and Hugging Face,
benchmark questions to the model cards, and give a set answer to
"which model powers you?" that links the Playground and API quickstart.
Describe LFM2.5-Embedding-350M as a text embedding model for retrieval
in RAG pipelines, say that LFM2.5-ColBERT-350M is the reranking model,
and name retrieval for RAG on the Nanos, Welcome and Complete Library
pages so people searching for embeddings find these models.
@iamleonie
iamleonie requested review from a team and mlabonne as code owners November 11, 2026 11:50
@mintlify

mintlify Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
liquid-docs 🟢 Ready View Preview Nov 13, 2026, 9:03 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

mlabonne
mlabonne previously approved these changes Nov 11, 2026
Comment thread link-snapshot.yaml
- /lfm/models/lfm25-vl-3b
- /lfm/models/lfm25-vl-450m
- /lfm/models/lfm25-vl-450m-extract
- /lfm/models/lfm3-1-7b

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this line duplicated?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a duplicate: this entry is /lfm/models/lfm3-1-7b (hyphen), a mistyped URL that still gets visits; the next line is the real /lfm/models/lfm3-1.7b. The new redirect in docs.json sends the hyphen version to the real page, and the snapshot records it. No change.

🤖 Addressed by Claude Code

Comment thread link-snapshot.yaml
- /lfm/fine-tuning/overview
- /lfm/fine-tuning/trl
- /lfm/fine-tuning/unsloth
- /lfm/frameworks/leap

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we sure we want to reintroduce it?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not bring the page back. /lfm/frameworks/leap was dropped in the #96 restructure with no redirect, but people still land on it from old links. This PR only adds a redirect from it to the "Migrating from LEAP SDK" page, which is the right place for anyone looking for LEAP now. The snapshot entry only records that redirect. Happy to drop it if you would rather that URL 404.

🤖 Addressed by Claude Code

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok thx claude

@alay2shah alay2shah changed the title Docs gap audit: first fixes Docs audit: discovery, assistant guidance, and LFM3 recommendations Nov 13, 2026

@alay2shah alay2shah left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the final audit changes, including indexing exclusions, assistant source guidance, LFM3 recommendations, direct deprecation replacements, and verified ONNX links. Mintlify build validation and both GitHub checks passed.

@alay2shah
alay2shah merged commit a0eaf0b into main Nov 13, 2026
5 checks passed
@alay2shah
alay2shah deleted the docs-audit branch November 13, 2026 21:06

This branch was successfully deployed

1 active deployment
staging — 1b21fbe2 Deployed Nov 13, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants