Skip to content

Fix LangChain and Docker quickstarts so they run as pasted - #81

Merged
ahellegit merged 2 commits into
mainfrom
fix/entry-surface-quickstarts
Oct 14, 2026
Merged

ahellegit merged 2 commits into
mainfrom
fix/entry-surface-quickstarts

Conversation

@cyborgcharlcye

@cyborgcharlcye cyborgcharlcye commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

Why

A developer who copies the LangChain quick start from this page gets an ImportError (langchain_openai is not installed by the langchain extra) and then an API-key validation failure on the placeholder key; the Docker quickstart asks for sudo and docker-compose v1 and lists specs for an image we no longer ship. On v0.18.0 this is the difference between a first query in about two minutes and giving up.

What changed

  • LangChain introduction, Embedded tab: uses the built-in all-MiniLM-L6-v2 model, api_key="" (free tier), and deletes the index at the end so the snippet can be re-run; adds the key-loss warning, a one-line "how to keep the index" pointer, a note that generate_key(save=True) is SDK-only, and OpenAI embeddings as an opt-in variant.
  • Quickstart page, LangChain card: api_key="" and a key-retention comment.
  • Quoted every pip install ...[extra] on current pages (zsh expands the brackets) and added a lint to scripts/docs.py check so it cannot regress.
  • Docker quickstart: an "evaluating vs deploying" line, no sudo, docker compose v2, and specs that match the shipped image (python:3.14-slim, about 124 MB compressed, no PyTorch).
  • Quickstart, Embedded quickstart and LangChain install steps: state that Python 3.10+ is required (macOS system python3 is 3.9 and pip install cyborgdb-core fails with no useful message on it).
  • docs.json: a "Quickstart" navbar link, the Get API Key button now goes to cyborgdb.co/new (the bare domain redirects to the marketing site), and a /quickstart-docker short redirect for READMEs.

Verification

  • Embedded snippet copied verbatim from the page into a fresh uv venv with cyborgdb-core[langchain]==0.18.0: run 1 and run 2 both print hello world / goodbye world (1.8 s and 0.4 s wall time); the reopen-by-constructor line was exercised the same way.
  • python3 scripts/docs.py check, sync-next --check and seo --check all pass; sync-next mirrored five pages into next/.
  • Not changed: the JS/TS tab still imports @langchain/openai; same class of issue, separate follow-up.

Closes cyborginc/cyborgdb-core#2706
Closes cyborginc/cyborgdb-core#2707
Closes cyborginc/cyborgdb-core#2708
Closes cyborginc/cyborgdb-core#2710
Refs cyborginc/cyborgdb-core#2705, cyborginc/cyborgdb-core#2701

@mintlify

mintlify Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
cyborg 🟢 Ready View Preview Oct 14, 2026, 5:12 PM

…tall steps

cyborgdb-core, cyborgdb and cyborgdb-service all require Python >= 3.10. The
python3 that ships with macOS is 3.9.6, and pip reports 'No matching
distribution found' with no hint why. A fresh-machine run today hit this
before any of the LangChain breaks this PR fixes.
@ahellegit
ahellegit merged commit c9fc657 into main Oct 14, 2026
6 checks passed
@ahellegit
ahellegit deleted the fix/entry-surface-quickstarts branch October 14, 2026 18:54

This branch was successfully deployed

1 active deployment
staging — 0089586d Deployed Oct 14, 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.

2 participants