You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
├── pipeline/ # Python build system & preprocessors
59
-
├── reference/ # Auto-generated API reference — do not edit
60
58
├── build/ # Build output — do not edit
61
59
├── scripts/ # Helper utilities
62
60
└── tests/ # Pipeline tests
63
61
```
64
62
65
63
## Navigation map
66
64
67
-
Navigation is defined in `src/docs.json`. The site has 4 products. When adding pages, find the correct product/tab/group below, then update the matching section in `docs.json`.
65
+
Navigation is defined in `src/docs.json`. The site has 4 products (Home, LangSmith, LangSmith Fleet, Open source). When adding pages, find the correct product/tab/group below, then update the matching section in `docs.json`.
68
66
69
67
### Home
70
68
@@ -74,37 +72,40 @@ Single page (`src/index.mdx`). No tabs.
| Reference | LangSmith Deployment (Agent Server API, Control Plane API), Releases |
86
84
87
-
### Agent Builder (`src/langsmith/`)
85
+
All LangSmith files are flat in `src/langsmith/` (no per-tab subdirectories except `fleet/` and `images/`).
88
86
89
-
Flat groups (no tabs), files in `src/langsmith/agent-builder/`:
87
+
### LangSmith Fleet (`src/langsmith/fleet/`)
88
+
89
+
Flat groups (no tabs):
90
90
91
91
- Get started
92
-
- Tools and integrations
92
+
- Configure
93
+
- Tools and automation
93
94
- Advanced
94
95
- Additional resources
95
96
96
97
### Open source (`src/oss/`)
97
98
98
-
2 language dropdowns (Python, TypeScript), each with 7 identical tabs:
99
+
2 language dropdowns (Python, TypeScript), each with 7 tabs sharing the same names. Groups listed below are for the Python dropdown; TypeScript groups differ in some tabs (noted with *).
99
100
100
-
| Tab | Directory |Notes|
101
-
|-----|-----------|-------|
102
-
| Deep Agents |`src/oss/deepagents/`| Get started, Core capabilities, Streaming, Protocols, CLI|
Always use the latest generally available (GA) models when referencing LLMs in docstrings and illustrative code snippets. Avoid preview or beta identifiers unless the model has no GA equivalent. Outdated model names signal stale code and confuse users.
213
+
214
+
Before writing or updating model references, verify current model IDs against the provider's official docs. Do not rely on memorized or cached model names — they go stale quickly.
215
+
209
216
## Adding pages
210
217
211
218
1. Create MDX file with required frontmatter in the correct directory (see navigation map above)
├── pipeline/ # Python build system & preprocessors
59
-
├── reference/ # Auto-generated API reference — do not edit
60
58
├── build/ # Build output — do not edit
61
59
├── scripts/ # Helper utilities
62
60
└── tests/ # Pipeline tests
63
61
```
64
62
65
63
## Navigation map
66
64
67
-
Navigation is defined in `src/docs.json`. The site has 4 products. When adding pages, find the correct product/tab/group below, then update the matching section in `docs.json`.
65
+
Navigation is defined in `src/docs.json`. The site has 4 products (Home, LangSmith, LangSmith Fleet, Open source). When adding pages, find the correct product/tab/group below, then update the matching section in `docs.json`.
68
66
69
67
### Home
70
68
@@ -74,37 +72,40 @@ Single page (`src/index.mdx`). No tabs.
| Reference | LangSmith Deployment (Agent Server API, Control Plane API), Releases |
86
84
87
-
### Agent Builder (`src/langsmith/`)
85
+
All LangSmith files are flat in `src/langsmith/` (no per-tab subdirectories except `fleet/` and `images/`).
88
86
89
-
Flat groups (no tabs), files in `src/langsmith/agent-builder/`:
87
+
### LangSmith Fleet (`src/langsmith/fleet/`)
88
+
89
+
Flat groups (no tabs):
90
90
91
91
- Get started
92
-
- Tools and integrations
92
+
- Configure
93
+
- Tools and automation
93
94
- Advanced
94
95
- Additional resources
95
96
96
97
### Open source (`src/oss/`)
97
98
98
-
2 language dropdowns (Python, TypeScript), each with 7 identical tabs:
99
+
2 language dropdowns (Python, TypeScript), each with 7 tabs sharing the same names. Groups listed below are for the Python dropdown; TypeScript groups differ in some tabs (noted with *).
99
100
100
-
| Tab | Directory |Notes|
101
-
|-----|-----------|-------|
102
-
| Deep Agents |`src/oss/deepagents/`| Get started, Core capabilities, Streaming, Protocols, CLI|
Always use the latest generally available (GA) models when referencing LLMs in docstrings and illustrative code snippets. Avoid preview or beta identifiers unless the model has no GA equivalent. Outdated model names signal stale code and confuse users.
213
+
214
+
Before writing or updating model references, verify current model IDs against the provider's official docs. Do not rely on memorized or cached model names — they go stale quickly.
215
+
209
216
## Adding pages
210
217
211
218
1. Create MDX file with required frontmatter in the correct directory (see navigation map above)
Copy file name to clipboardExpand all lines: Makefile
+9-1Lines changed: 9 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
.PHONY: all dev build format lint test install clean lint_md lint_md_fix lint_prose broken-links broken-links-with-anchors format-check code-snippets test-code-samples check-cross-refs
1
+
.PHONY: all dev build export format lint test install clean lint_md lint_md_fix lint_prose broken-links broken-links-with-anchors format-check code-snippets test-code-samples check-cross-refs
2
2
3
3
# Default target
4
4
all: help
@@ -13,6 +13,13 @@ build:
13
13
npm install
14
14
PYTHONPATH=$(CURDIR) uv run pipeline build
15
15
16
+
# Offline zip via Mintlify (https://www.mintlify.com/docs/deploy/export).
17
+
# Must run from build/: docs.json paths are oss/python/... and oss/javascript/... but sources live under src/oss/... until the pipeline emits build/oss/{python,javascript}/...
18
+
# Example: make export MINT_EXPORT_ARGS='--output ../langchain-docs-export.zip'
19
+
export: build
20
+
@command -v mint >/dev/null 2>&1|| { echo"Error: mint not installed. Run: npm install -g mint@latest";exit 1; }
21
+
@cd build && mint export$(MINT_EXPORT_ARGS)
22
+
16
23
# Define a variable for the test file path.
17
24
TEST_FILE ?= tests/unit_tests
18
25
@@ -157,6 +164,7 @@ help:
157
164
@echo "Available commands:"
158
165
@echo " make dev - Start development mode with file watching and mint dev"
159
166
@echo " make build - Build documentation to ./build directory"
167
+
@echo " make export - Run mint export from ./build (optional: MINT_EXPORT_ARGS)"
160
168
@echo " make broken-links - Check for broken links in built documentation"
161
169
@echo " make check-cross-refs - Check for unresolved @[ref] cross-references"
162
170
@echo " make broken-links-with-anchors - Same as above, also validates anchor links"
0 commit comments