Commit Graph

36 Commits

Author SHA1 Message Date
Naomi Pentrel 5907a8d9cc fix link checking for snippets (#5179) 2026-07-29 13:16:04 +02:00
Naomi Pentrel b4a89165c5 curate integrations docs for integrations with less than 50K monthly downloads (#4865) 2026-07-28 14:25:28 +02:00
langsmith-fleet[bot] cb5656a03a Weekly LangSmith changelog: July 20-24, 2026 (#4978)
Weekly LangSmith changelog for July 20-24, 2026.

Source fragments: ready entries from `langchainplus/.changelog` for the
July 20-24 weekly window.

Held fragments: 38 entries remained held because their feature flags
were not fully rolled out yet.
Skipped fragments: 6 invalid entries were skipped because they are held
without a flag.

Agent involvement: assembled and polished by an agent.

---------

Co-authored-by: Lauren <lauren@langchain.dev>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
2026-07-20 09:35:16 -07:00
Andy Young 59bd0c60c1 docs: add annotation-queue add-runs (by-key) to SmithDB migration guide (#4895) 2026-07-15 14:19:52 -07:00
Quentin Brosse ea9bb6eb87 docs: add Traces SDK methods to SmithDB migration guide (#4790)
## Summary

Adds 2 new v2 SDK methods to the SmithDB migration guide:

- `traces.query`
- `traces.list_runs`

Each gets Python, TypeScript, Go, Java, and cURL before/after examples.

Split off the threads methods (`threads.query`, `threads.list_traces`,
`threads.stats`) into #4847 so this PR covers only the traces methods.
2026-07-15 13:56:55 +02:00
Mason Daugherty d2f1324831 Pin Node 22 for docs development (#4797)
Pins local docs development to Node 22 so `docs dev` uses a
Mintlify-supported LTS runtime instead of failing under Node 25+.

This also documents the distinction between the Python `docs` CLI and
the Mintlify `mint` CLI, and adds a small install hint for shells that
need to be relaunched before `.venv/bin/docs` is on `PATH`.
2026-07-08 23:03:53 -04:00
Lauren Hirata Singh 1822bd65ab Docs IA rework to agent dev lifecycle (#4075)
Fixes DOC-1238 


https://www.notion.so/Docs-Information-Architecture-ADLC-Revamp-373808527b1780cbae0bd0098b3d963f?source=copy_link

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-11 16:11:28 -04:00
Lauren Hirata Singh ec0c5197c7 fix local link check (#4373)
fixes DOC-1230
2026-06-09 17:05:57 -04:00
Naomi Pentrel 163fbae309 make rag tutorial testable & not use community (#4239) 2026-06-01 19:36:52 +02:00
Lauren Hirata Singh 7a8607fe4f add LangSmith API docs to mintlify (#3593)
Fixes DOC-878

```
There are 84 hidden endpoints across these categories:                                         
  ┌─────────────────────────────────┬───────┬───────────────────────────────────┐                
  │            Category             │ Count │            Why hidden             │                
  ├─────────────────────────────────┼───────┼───────────────────────────────────┤                
  │ Fleet (agents, skills, fleet *) │ 72    │ Fleet has its own product/docs    │                
  ├─────────────────────────────────┼───────┼───────────────────────────────────┤                
  │ fleet github-app                │ 11    │ Fleet-specific GitHub integration │                
  ├─────────────────────────────────┼───────┼───────────────────────────────────┤                
  │ beacon                          │ 1     │ Internal usage telemetry          │                
  ├─────────────────────────────────┼───────┼───────────────────────────────────┤                
  │ nps                             │ 1     │ Internal NPS survey               │                
  ├─────────────────────────────────┼───────┼───────────────────────────────────┤                
  │ sandboxes-internal              │ 1     │ Service-to-service only           │                
  ├─────────────────────────────────┼───────┼───────────────────────────────────┤                
  │ metrics                         │ 1     │ Internal queue metrics            │                
  ├─────────────────────────────────┼───────┼───────────────────────────────────┤              
  │ (untagged) — GET /ok            │ 1     │ Health check                      │              
  └─────────────────────────────────┴───────┴───────────────────────────────────┘  
  ```
  
 PREVIEW: https://langchain-5e9cc07a-preview-lsapi-1779323176-451247e.mintlify.app/langsmith/smith-api-ref
2026-05-21 17:40:17 -04:00
Naomi Pentrel 7f9e0a327b add codespell testing to lint (#3995) 2026-05-13 22:10:45 +02:00
open-swe[bot] 74c3c110c7 docs: port deepagents permissions docs to javascript (#3856) 2026-05-05 15:15:24 +02:00
Naomi Pentrel 2dbd68b821 update makefile with export command (#3526) 2026-04-10 12:49:11 +02:00
Mason Daugherty e0d7bb27e9 feat: add CI check for unresolved @[ref] cross-references (#3051)
## Description
Adds a check that validates all `@[ref]` cross-references in source
MDX/MD files resolve against entries in `link_map.py`. Previously,
unresolved references silently passed through the build pipeline and
appeared as raw `@[ClassName]` text in the published docs. Available via
`make check-cross-refs`.

Note: I couldn't modify `.github/workflows/_check-links.yml` due to
workflow permissions. To integrate into CI, add this step to
`_check-links.yml` after "Install Python dependencies":
```yaml
- name: Check for unresolved cross-references
  run: make check-cross-refs
```

## Test Plan
- [ ] `make check-cross-refs` reports unresolved references with file,
line number, and scope
- [ ] 12 unit tests covering: valid refs, unresolved refs, scope fences,
code block skipping, escaped refs, titled refs, backtick refs, and
code-samples exclusion

---------

Co-authored-by: open-swe[bot] <open-swe@users.noreply.github.com>
Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com>
2026-03-13 17:35:55 -04:00
Mason Daugherty 5a17fc0df3 switch to tyfor type checking (#3121) 2026-03-13 17:18:19 -04:00
Mason Daugherty c57ece47ff delete reference/ (#3109)
delete folder

relocate `packages.yml` and update corresponding scripts
2026-03-13 15:08:14 -04:00
Christian Bromann c0ac46fe0a feat: frontend docs (#2930)
## Overview

Split the monolithic streaming/frontend documentation pages into
individual pattern-specific pages across LangChain, LangGraph, and
DeepAgents. Each page covers a single frontend pattern (tool calling,
human-in-the-loop, branching chat, etc.) with an interactive playground
embed powered by the `@langchain/docs-sandbox` npm package.

Also restructures the "Streaming" nav groups into a top-level
"Streaming" page and a new "Frontend" nav group for each product.

## Type of change

**Type:** New documentation page / Update existing documentation

## Related issues/PRs

- GitHub issue:
- Feature PR:
- Linear issue:
- Slack thread:

## Checklist

- [x] I have read the [contributing guidelines](README.md)
- [x] I have tested my changes locally using `docs dev`
- [ ] All code examples have been tested and work correctly
- [ ] I have used **root relative** paths for internal links
- [ ] I have updated navigation in `src/docs.json` if needed

(Internal team members only / optional): Create a preview deployment as
necessary using the [Create Preview Branch
workflow](https://github.com/langchain-ai/docs/actions/workflows/create-preview-branch.yml)

## Additional notes

### New frontend pattern pages

**LangChain** (10 pages):
`tool-calling`, `human-in-the-loop`, `branching-chat`,
`optimistic-updates`, `reasoning-tokens`, `structured-output`,
`async-iterator-tools`, `message-queues`, `join-rejoin`, `time-travel`

**DeepAgents** (2 pages):
`subagent-streaming`, `todo-list`

**LangGraph** (1 page):
`graph-execution`

Each page includes a `<PatternEmbed>` component that renders an
interactive playground preview from the `@langchain/docs-sandbox`
package.

### Playground embed build pipeline

The `PatternEmbed` component is now sourced from the
`@langchain/docs-sandbox` npm package rather than being manually
maintained in the source tree:

- Added `package.json` with `@langchain/docs-sandbox@0.0.3` dependency
- Added `.npmrc` with `legacy-peer-deps=true` (needed because the
package declares a peer dependency using pnpm's `workspace:*` protocol)
- Updated `pipeline/core/builder.py` to copy
`node_modules/@langchain/docs-sandbox/dist/PatternEmbed.jsx` →
`build/snippets/pattern-embed.jsx` during the build step
- CI pipelines need to run `npm install` before building docs

### Navigation changes (`src/docs.json`)

- Collapsed `Streaming` sub-group (overview + frontend) into a single
top-level `streaming` page under LangChain and DeepAgents
- Added new `Frontend` nav groups for LangChain (10 pages), DeepAgents
(3 pages including overview), and LangGraph (2 pages including overview)

---------

Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com>
2026-03-12 08:26:10 -07:00
Naomi Pentrel 2abd4dffbd Fix some link fragments (#3083) 2026-03-12 11:48:09 +01:00
Naomi Pentrel c25152658e chore: standardize prebuilt terminology and add vale linting (#2958) 2026-03-09 18:36:28 +01:00
Naomi Pentrel 71642e5be0 update GitHub action for linkcheck (#2945) 2026-03-05 21:31:30 +01:00
Naomi Pentrel 09916e89b6 automate tests (#2893) 2026-03-04 16:31:52 +01:00
Naomi Pentrel 14a8588131 fix broken linkcheck (#2651)
Co-authored-by: Lauren Hirata Singh <lauren@langchain.dev>
2026-02-16 16:41:59 +01:00
Lauren Hirata Singh 6cae3ed49b fix broken links + gh action (#1702) 2025-12-02 12:25:13 -05:00
William FH b9634849f0 Agent server openapi spec (#1628)
Right now we redirect to another git site and use `scalar` to host the
api refs.

Scalar's docs are nicer, but Mintlify doesn't seem to support hosting
static html (lol).
They do support some meh api reference doc generation from an openapi
spec though.
This PR uses that.
2025-12-01 17:36:37 -05:00
Christian Bromann b56c3f09df fix: install mintlify CLI (#1584)
I got an error running the docs page due to the fact that I didn't had
the latest Mintlify CLI package installed. Should we add it to the `make
install` command?
2025-11-25 22:22:22 -05:00
Naomi Pentrel bd808ce0b1 Fix broken links and fail on new broken links (#898)
## Overview
This updates a number of broken links and adds a GitHub action that
fails if there are more than 5 broken links. This is an arbitrary
number based on a number of template links and a few broken links I
don't know how to fix.

## Type of change

**Type:** bug/other

## Checklist
- [x] I have read the [contributing guidelines](README.md)
- [x] I have tested my changes locally using `docs dev`
- [x] All code examples have been tested and work correctly
- [x] I have used **root relative** paths for internal links
- [x] I have updated navigation in `src/docs.json` if needed
- [x] I have gotten approval from the relevant reviewers

## Additional notes

>If you can add the `hacktoberfest-accepted` label to this PR that would
be appreciated! Thanks!

---------

Co-authored-by: Lauren Hirata Singh <lauren@langchain.dev>
2025-10-15 13:31:28 -04:00
Mason Daugherty 78d62b243b oss ref work (#774) 2025-10-07 15:09:47 -04:00
Mason Daugherty 37e3da7be7 more reference docs updates / README.md update (#716) 2025-10-01 15:53:47 -04:00
Lauren Hirata Singh 7ce08366fc Add redirects + update link checker (#696)
## Overview
- Update link checker to use built-in `mint broken-links` now that
most/all broken links have been fixed
- Add redirects for new <> new pages that get a lot of 404s

## Type of change

**Type:** Bug fix + CI/CD

## Checklist
<!-- Put an 'x' in all boxes that apply -->
- [ ] I have read the [contributing guidelines](README.md)
- [ ] I have tested my changes locally using `docs dev`
- [ ] All code examples have been tested and work correctly
- [ ] I have used **root relative** paths for internal links
- [ ] I have updated navigation in `src/docs.json` if needed
- I have gotten approval from the relevant reviewers
- (Internal team members only / optional) I have created a preview
deployment using the [Create Preview Branch
workflow](https://github.com/langchain-ai/docs/actions/workflows/create-preview-branch.yml)

## Additional notes
<!-- Any other information that would be helpful for reviewers -->
2025-09-30 13:56:30 -04:00
Mason Daugherty c83608fe5f chore: linting, formatting, bumps (#658)
* Bump to latest actions, `mint`, Python, lock
* Run linting/formatting/tests
2025-09-25 23:11:45 -04:00
Hunter Lovell 910001ce1a feat: reference docs (#640)
Adds a new `reference/` path that centralizes the logic for creating
reference documentation

## For Python

We can leverage the existing reference docs pipeline thats used within
the `langchain` repo, and adapting it to include docs from more sources
(see https://github.com/langchain-ai/langchain/pull/33066). More details
about how this works are in `reference/python/README.md`.

## For TypeScript

We'll be keeping the existing [typedoc](https://typedoc.org/) library to
render references, but we're onshoring the work of consolidating those
into one reference site within this repo.

The basic process of how that happens is:
* by reading a statically defined list of packages and their locations
(defined in reference/javascript/build.ts`)
* doing a shallow clone of each unique repo + branch
* doing the appropriate install steps so that types can be inferred
properly
* extracting package entrypoints by reading the `exports` key in
`package.json`
* pointing typedoc to add those as entrypoints with the [packages
strategy](https://typedoc.org/documents/Options.Input.html#packages)
* building the typedoc outputs to reference/dist/javascript/

## New `make` targets

- `make build-references` will run scripts to format python + js
reference documentation concurrently (which will end up in
reference/dist/)
- `make preview-references` will run aforementioned build scripts and
start a dev server (this won't work until a vercel project is
configured)

## Vercel Setup

In order for these changes to be reflected on `reference.langchain.com`,
a new Vercel project needs to be created (which can happen once this is
merged).

This was tested against a "test" vercel setup and works as expected,
with both reference targets accessible from their respective subpaths
2025-09-24 17:30:34 -04:00
Lauren Hirata Singh e69a3328ed Lint files + add a PR labeler (#534)
## Overview
- make lint / make format
- added a PR labeler

## Type of change
**Type:**  Infra

## Related issues/PRs
<!-- Link to related issues, feature PRs, or discussions (if applicable)
-->
- GitHub issue:
- Feature PR:

<!-- For LangChain employees, if applicable: -->
- Linear issue:
- Slack thread:

## Checklist
<!-- Put an 'x' in all boxes that apply -->
- [x] I have read the [contributing guidelines](README.md)
- [x] I have tested my changes locally using `docs dev`
- [x] All code examples have been tested and work correctly
- [x] I have used **root relative** paths for internal links
- [x] I have updated navigation in `src/docs.json` if needed
- [x] I have gotten approval from the relevant reviewers
- [ ] (Internal team members only / optional) I have created a preview
deployment using the [Create Preview Branch
workflow](https://github.com/langchain-ai/docs/actions/workflows/create-preview-branch.yml)

## Additional notes
<!-- Any other information that would be helpful for reviewers -->
2025-09-15 11:18:50 -04:00
Lauren Hirata Singh 23dc7f8051 Misc. cleanup / standardization (#425)
# Documentation update

## Overview
<!-- Brief description of what documentation is being added/updated -->
- Updated broken links in all docs that **are not** under
`python/integrations` or `javascript/integrations` (these will be
addressed later)
- Updated broken-links scripts (locally and GH actions) to ignore the
integrations directories
- Changed .md files to .mdx
- Fixed vscode settings
- Added vscode extension suggestions

## Type of change
<!-- Check the relevant box -->
- [ ] New documentation page
- [ ] Update existing documentation
- [x] Fix typo, bug, broken link, or formatting issue
- [ ] Remove outdated content
- [ ] Other (please describe):

## Related issues/PRs
<!-- Link to related issues, feature PRs, or discussions (if applicable)
-->
- GitHub issue:
- Feature PR:

<!-- For LangChain employees, if applicable: -->
- Linear issue:
- Slack thread:

## Checklist
<!-- Check all that apply -->
- [x] I have read the [contributing guidelines](README.md)
- [x] I have tested my changes locally using `docs dev`
- [x] All code examples have been tested and work correctly
- [x] I have used **root relative** paths for internal links
- [x] I have updated navigation in `src/docs.json` if needed
- [x] I have gotten approval from the relevant reviewers
- [x] (Internal team members only / optional) I have created a preview
deployment using the [Create Preview Branch
workflow](https://github.com/langchain-ai/docs/actions/workflows/create-preview-branch.yml)

## Additional notes
<!-- Any other information that would be helpful for reviewers -->
2025-09-09 14:20:55 -04:00
Lauren Hirata Singh ea1d381d3a fix mint broken links (#411)
Problem: Running mint broken-links from project root caused Mintlify to
parse Python virtual environment files in .venv/, triggering MDX parsing
errors (CI tests).

Fix: Updated Makefile so make mint-broken-links runs the command from
the src/ directory (where docs.json lives) instead of project root,
avoiding the .venv/ directory entirely.
2025-09-08 15:24:51 -04:00
Mason Daugherty 032d06251a oss: LINTING; add markdownlint to Makefile and run on oss/ (#342)
Big fella - no content changes, just (mostly) automatic linting via
`lint-md.sh`

- Ran `markdownlint` in all `oss/` files
  - Also added plugin to `IDE_SETUP.md`
- Ensure all integration files use inline links instead of the html-link
syntax (`<https://example.com` -> `[]()`)
- Added markdown linting to `Makefile`
- Bump `ruff` and `mypy` & lock
- Manually went through all `langchain-*` files
  - Ensured no hard line breaks
  - Indent Mintlify component content
- Note: had to resolve a gnarly merge conflict in `langchain-models`,
may want to pay extra attention

---------

Co-authored-by: Brody <beklapko@gmail.com>
2025-09-03 14:37:55 -04:00
Eugene Yurtsev 3d2e9bbbda Add scaffolding for build pipeline (#5)
- [x] Split into /src and /build directories
- [x] make build -- will be used for building the final documentation
- [x] make dev -- builds docs, then launches mint dev + utility to watch
for file changes in src

----

Follow up PR


- [ ] Add unit tests [in progress]
- [ ] Hook up github workflow for testing
- [ ] Add pre-processors for ipython notebooks, so we can re-use
existing notebooks from langgraph
- [ ] recursive descent parser to map from mkdocs to mintlify md syntax
(to simplify migration)
- [ ] Build API references in python
- [ ] Build API references in js
2025-06-03 15:23:31 -04:00