langchain-ai/docs

What it solves

Writing and maintaining documentation for a large, multi-project ecosystem is messy. This repo provides a single, automated pipeline that turns source files into a polished documentation website (docs.langchain.com) for LangChain, LangGraph, LangSmith, and related tools. It also gives contributors a set of commands to preview, build, and check the docs locally, so errors are caught before publishing.

How it works

Content lives as Markdown files (.md and .mdx) inside the src/ folder, which is the only place you should edit. A build script preprocesses those files and outputs a ready-to-deploy version into the build/ folder. That folder is what Mintlify (the hosting platform) actually serves. The repo also contains helper scripts, package metadata, and a configuration file (docs.json) that controls navigation and settings.

For day-to-day work, you use Make commands: make install sets up dependencies, make dev starts a local server with live reload, make build generates the static files, and make test runs the test suite. There is also a docs command-line tool that can convert older-format Markdown or Jupyter notebooks into the Mintlify-friendly format (including from MkDocs or Docusaurus projects), and move files while updating cross-links. To keep quality high, the repo includes two linters: codespell catches spelling errors in prose, and vale checks style against a rules file. The README also explains how to troubleshoot common Mintlify issues, such as broken links caused by running Mintlify from the wrong directory.

Who it’s for

Contributors to LangChain documentation—anyone who wants to write, edit, or fix pages on docs.langchain.com. It’s also useful for maintainers who need to manage the build process, migrate legacy docs, or ensure links and style stay consistent. The README assumes you are comfortable with the command line and Git, but it explains all the steps clearly.

Highlights

• Single source of truth: edit src/, run a command, and Mintlify deploys from build/.
• Preview locally with hot reload (make dev).
• Automatic link checking (including anchors) via make broken-links-with-anchors.
• Migration tools to convert existing docs from MkDocs or Docusaurus into Mintlify format.
• Linting for spelling (codespell) and style (vale) to keep prose consistent.
• Clear troubleshooting section for common Mintlify pitfalls, such as .venv parsing errors.