## 1. Project Overview & Quickstart (langchain-ai/models) # models Models and examples built with TensorFlow ### Repository Details - **Repository:** [langchain-ai/models](https://github.com/langchain-ai/models) - **GitHub Stars:** ⭐ 77,661 - **Primary Language:** Python *Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.* ## 2. Official Technical Reference & Guides (langchain-ai/docs) # LangChain Docs 🦜 **Welcome!** This repository contains the documentation build pipeline for LangChain projects. * 🏠 [`docs.langchain.com`](https://docs.langchain.com) is our docs home, centralizing LangChain, LangGraph, LangSmith, and LangChain Labs (Deep Agents, Open SWE, Open Agent Platform). This site is hosted on [Mintlify](https://mintlify.com). * 🛠️ [`reference.langchain.com`](https://reference.langchain.com/python/) hosts generated API reference for LangChain, LangGraph, LangSmith, and integration packages. That site is **not** built from this repository (no reference build scripts or output live here). * [`Python reference`](https://reference.langchain.com/python/) * [`JavaScript/TypeScript reference`](https://reference.langchain.com/javascript/) * 💬 [`chat.langchain.com`](https://chat.langchain.com) is an AI-powered assistant that can answer questions about LangChain documentation. --- **Table of contents:** - [LangChain Docs](#langchain-docs) - [Contribute](#contribute) - [Reference](#reference) - [Repository structure](#repository-structure) - [`docs.langchain.com`](#docslangchaincom) - [`reference.langchain.com`](#referencelangchaincom) - [File formats](#file-formats) - [Available commands](#available-commands) - [Linting](#linting) - [Codespell](#codespell) - [Troubleshooting](#troubleshooting) - [`docs dev` not working / running](#docs-dev-not-working--running) - [Mintlify `.venv` parsing error](#mintlify-venv-parsing-error) - [Warning: page doesn't exist](#warning-page-doesnt-exist) - [General Mintlify errors](#general-mintlify-errors) --- ## Contribute To run a local preview of the documentation: ```bash git clone https://github.com/langchain-ai/docs.git ``` ```bash cd docs ``` ```bash make install ``` ```bash make dev ``` For more information on how to contribute to LangChain documentation, follow the steps outlined in the [contributing guide](https://docs.langchain.com/oss/python/contributing/overview). The contributing guide also explains our documentation types and their writing and quality standards. For detailed information about setting up your development environment and contributing to documentation, see the [documentation contributing guide](https://docs.langchain.com/oss/python/contributing/documentation). To report issues with **reference.langchain.com** (missing pages, broken links, or generated API content), [open a reference documentation issue](https://github.com/langchain-ai/docs/issues/new?template=04-reference-docs.yml) on this repo so maintainers can route it. ## Reference ### Repository structure ```text # --- docs.langchain.com ---------------------------------------------- build/ # Built docs (DO NOT EDIT) packages.yml # Package metadata (indexes, tables, downloads; not the API reference build) pipeline/ # Build pipeline source code scripts/ # Helper scripts src/ # Source documentation files (< EDIT CONTENT HERE) langsmith/ # LangSmith docs oss/ # LangChain, LangGraph, Deep Agents, and integrations docs docs.json # Mintlify site configuration and navigation tests/ # Test files for the pipeline Makefile # Build targets pyproject.toml # Dependencies ``` #### `docs.langchain.com` The Mintlify docs pipeline is structured with `.mdx` source files in `/src` and build artifacts in `/build`. Mintlify deploys from the `/build` folder, which is generated by preprocessing logic. > [!IMPORTANT] > Never edit `/build` directly. The `/src/docs.json` file is used to configure the Mintlify site navigation and settings. Refer to the [Mintlify documentation](https://www.mintlify.com/docs/organize/navigation) for detailed syntax and component usage. Documentation changes follow a PR workflow where all tests must pass before merging. See the [contributing guidelines](https://docs.langchain.com/oss/python/contributing/documentation) for more details. #### `reference.langchain.com` API reference is generated and deployed outside this repo. Browse [Python](https://reference.langchain.com/python/) and [JavaScript/TypeScript](https://reference.langchain.com/javascript/) reference there. If something is wrong with that site, use the [reference docs issue template](https://github.com/langchain-ai/docs/issues/new?template=04-reference-docs.yml). ### File formats * **Markdown files** (`.md`, `.mdx`) - Standard documentation content * **Snippets** (`src/snippets/`) - Reusable MDX content that can be imported into multiple pages. **Important:** Snippets undergo special link preprocessing. When writing links in snippets, be careful about path segments. * **Jupyter notebooks** (`.ipynb`) - Converted to markdown during build, though **these are not recommended for new content!** Your PR will likely be rejected if you attempt to add a Jupyter notebook unless asked to by a maintainer. * **Assets** - Images and other files are copied to the build directory ### Available commands **Make commands:** * `make dev` - Start development mode with file watching and live rebuild * `make build` - Build documentation to `./build` directory * `make broken-links` - Check for broken links in documentation * `make broken-links-with-anchors` - Check for broken links + check links with anchors * `make install` - Install all dependencies * `make clean` - Remove build artifacts * `make test` - Run the test suite * `make lint` - Check code style and formatting * `make format` - Auto-format code * `make lint_md` - Lint markdown files * `make lint_md_fix` - Lint and fix markdown files * `make help` - Show all available commands **`docs` CLI tool:** The `docs` command (installed as `uv run docs`) provides additional functionality: * **`docs migrate `** - Convert MkDocs markdown/notebook files to Mintlify format * `--dry-run` - Preview changes without writing files * `--output ` - Specify output location (default: in-place) * Supports `.md`, `.markdown`, `.ipynb` files * **`docs migrate-docusaurus `** - Convert Docusaurus markdown/notebook files to Mintlify format * `--dry-run` - Preview changes without writing files * `--output ` - Specify output location (default: in-place) * Supports `.md`, `.markdown`, `.mdx`, `.ipynb` files * Converts Docusaurus-specific syntax (admonitions, tabs, imports, etc.) * **`docs mv `** - Move files and update cross-references * `--dry-run` - Preview changes without moving files These can be used directly using the `Makefile` or via the `docs` CLI tool: * **`docs dev`** - Start development mode with file watching and hot reload * Automatically rebuilds changed files from `src/` to `build/` * Launches Mintlify dev server at * Provides automatic browser refresh when files change * `--skip-build` - Skip initial build and use existing build directory * **`docs build`** - Build documentation files * `--watch` - Watch for file changes after building ## Linting After running `make install`, you can use `make lint_prose` to ensure your writing meets our style guide rules. ### Codespell `make lint` runs `uv run codespell src` to check source documentation for common spelling errors. Codespell is configured in `pyproject.toml` under `[tool.codespell]`: * Add custom accepted words to `src/.codespellignore`. This file is referenced by `ignore-words = "src/.codespellignore"`. * Exclude generated files, vendor content, or other paths that should not be spell checked by adding glob patterns to the `skip` setting. * Keep skip patterns scoped. Prefer adding accepted words to `src/.codespellignore` when the word is valid documentation content, and use `skip` when the file or directory should not be checked at all. You can also follow these steps to enable `vale` with VS Code or Cursor: 1. Install the [Vale extension](https://marketplace.visualstudio.com/items?itemName=chrischinchilla.vale-vscode) (Vale by Chris Chinchilla) 2. Install Vale CLI: `brew install vale` (macOS) or see [Vale installation](https://vale.sh/docs/vale-cli/installation/) for other platforms 3. Navigate to the Vale extension settings: - Set `Vale CLI: Config` to the absolute path to `.vale.ini` (in the root of this repo) - Set `Vale CLI: Min Alert Level` to `suggestion` (many rules are coded as suggestions) If you cannot use the VS Code UI to configure Vale, add these settings to your `settings.json`: ```json "vale.valeCLI.config": "/path/to/docs/.vale.ini", "vale.valeCLI.minAlertLevel": "suggestion" ``` **Note:** The extension requires Vale on your `PATH`. If annotations don't appear (e.g., when Cursor is launched from the Dock), launch Cursor from a terminal so it inherits your PATH, or ensure Homebrew is in your shell profile. ## Troubleshooting ### General Mintlify errors In some cases, we use new features that are only available in the latest Mintlify CLI. If you encounter errors, ensure you have the latest version installed: ```bash mint update # or npm install mint ``` ### `docs dev` not working / running Re-do the [steps to set up your dev environment](https://docs.langchain.com/oss/python/contributing/documentation#set-up-local-environment), ensuring you have activated the virtual environment and installed all dependencies. > [!IMPORTANT] > Most of the time, `mint update` solves any `docs dev` / `make dev` issues! ### Mintlify `.venv` parsing error **Problem**: Running `mint broken-links` or other Mintlify commands from the project root causes parsing errors like: ```txt Unable to parse .venv/lib/python3.13/site-packages/soupsieve-2.7.dist-info/licenses/LICENSE.md - 3:48: Unexpected character '@' (U+0040) in name ``` **Root Cause**: Mintlify tries to parse all files in the directory, including Python virtual environment files that contain invalid MDX syntax. **Solutions** (in order of preference): 1. **Use the safe Make commands** (recommended): ```bash make broken-links-with-anchors # Builds docs first, then checks internal links ``` 2. **Run Mintlify commands from the build directory**: ```bash cd build # Change to build directory where final docs are mint broken-links # Now safe to run ``` **Why this works**: The solution ensures Mintlify commands run from the `build/` directory where the final documentation is generated, which is the correct place to check for broken links. This avoids scanning the Python virtual environment in the project root. **Prevention**: Always use the provided Make commands instead of running raw `mint` commands from the project root. ### Warning: page doesn't exist If adding a new group, ensure the root `index.mdx` is included in the `pages` array like: ```json { "group": "New group", "pages": ["new-group/index", "new-group/other-page"] } ``` If the trailing `/index` (no extension included) is omitted, the Mintlify parser will raise a warning even though the site will still build.