docs: replace slow Inkeep search with offline local search - #192
Merged
Conversation
* docs(blog): make /blog responsive - Add mobile styles to swizzled BlogListPage (hero, marquee, posts, pagination). - Fix horizontal overflow caused by the marquee's white-space: nowrap propagating width up the flex chain. Break it with min-width: 0 on .page and #__docusaurus > *, plus defensive overflow-x: clip. - Respect prefers-reduced-motion (stop marquee animation). * Remove global overflow prevention styles Removed global styles to prevent horizontal overflow on mobile.
…ides (#31) Backfills the `BerriAI/litellm-docs` site with the changes that originally shipped under `docs/my-website/` in BerriAI/litellm#25939 / #26325. After the docs source was migrated to this repo, those edits could no longer be carried in the code PR and were dropped on rebase. - proxy/token_auth.md: expand "Matching behavior" with AND semantics, the new optional `scope` selector, list/string forms, shell-style wildcards (`*`, `?`, case-sensitive), and the scope-only space-split rule (iss/aud/client_id are never split on spaces). Adds a worked example combining `scope` with a wildcard `client_id`. - proxy/oauth2.md: cross-reference the new wildcard/scope behavior and point readers to token_auth.md for full details. Code change is in BerriAI/litellm#26325 (litellm_internal_staging).
…) (#184) * docs(mcp,a2a): code-verified auth reference fixes + overview page (#156) * docs(mcp): complete auth_type table, OAuth config reference, RBAC intersection model, hub-vs-public-internet distinction * docs(a2a): document x-litellm-api-key, trace-id enforcement, sub-agent propagation, agent access groups and full intersection model * docs(bedrock_agentcore): add LiteLLM A2A Gateway section — fixes broken anchor from a2a.md, documents dual JWT/SigV4 auth modes and full credential chain * docs: add AuthN/AuthZ overview page side-by-siding MCP and A2A gateways * docs(fixup): corrections from code-review pass — verified against current LiteLLM source * make changes --------- Co-authored-by: michelligabriele <gabriele.michelli@icloud.com>
litellm_version: v1.83.14-stable claude_code_version: 2.1.126 generated_at: 2026-05-20T06:09:45Z Co-authored-by: litellm-compat-matrix-bot <litellm-bot@berri.ai>
The OpenAI Python SDK rejects guardrails as a top-level argument; use extra_body to send LiteLLM-specific params to the proxy. Co-authored-by: Cursor <cursoragent@cursor.com>
Patch releases on top of v1.84.0 and v1.85.0, each shipping the same three PRs: Gemini 3.5 Flash day-0 support (#28268), a Vertex AI tool-calling fix for Gemini 3.5+ HTTP 400 errors (#28324), and a cross-pod spend-counter seeding fix (#27854). Adds release_notes/v1.84.1/ and release_notes/v1.85.1/ pages and updates the release_notes overview (Latest Release block + table).
…search-local Inkeep search was reported as slow and exhibited focus / Cmd+K bugs (cursor in the wrong place, page preventing repeated searches). Swap the navbar SearchBar over to @easyops-cn/docusaurus-search-local, which builds a static lunr index at build time and renders results instantly on the client. - Add @easyops-cn/docusaurus-search-local theme with both docs and release_notes routes indexed. - Keep stop words and stems (technical docs frequently search short tokens) and enable highlight-on-target-page. - Drop the SearchBar config from @inkeep/cxkit-docusaurus so it only provides the floating Ask AI chat button (still useful for AI Q&A). Co-authored-by: Mateo Wang <mateo-berri@users.noreply.github.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
9 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Docs search (powered by Inkeep) was reported as slow on
docs.litellm.aiand exhibited several UX bugs:Cmd+Kdoesn't reliably reopen the search bar with focus.What
Swap the navbar search bar over to
@easyops-cn/docusaurus-search-local, a popular Docusaurus theme that builds a static lunr index at build time and runs entirely on the client. Searches are effectively instant — there is no network call and no third‑party SLA in the search path. The library also reliably wires upCmd+Kfocus and modal open/close, fixing the focus regressions reported above.The floating Ask AI chat button (
@inkeep/cxkit-docusaurus) is preserved — only the slow hosted search integration is removed.Changes
docusaurus.config.js@easyops-cn/docusaurus-search-localunderthemes, indexing bothdocsandrelease_notesplus the blog.removeDefaultStopWordFilter: true), enable on-page highlight,mod+kshortcut, hashed index (long-term cache friendly).SearchBarconfig from the@inkeep/cxkit-docusaurusplugin so it only provides theChatButton(Ask AI). The InkeepSearchBarcomponent rendersnullwithout a config, and the easyops theme (loaded later underthemes:) provides the active@theme/SearchBarimplementation.package.json/package-lock.json— add@easyops-cn/docusaurus-search-local@0.55.1.Verification
npm run buildsucceeds (the broken-anchor warnings inrelease_notes/*are pre‑existing and unrelated).build/search-index.jsonis generated (~29 MB lunr index covering docs + release notes + blog).@theme/SearchBaris the easyops implementation (DocsPreferredVersionContextProviderwrapper present, noInkeepSearchBarsymbols inmain.*.js).ikp-chat-button__button) is still bundled, so Ask AI remains available.Notes
@easyops-cn/docusaurus-search-localsupports an optionalaskAiconfig that we can wire up in a follow-up.Slack Thread