Skip to content

Commit 22c8cf0

Browse files
mdrxyCopilot
andauthored
10/27 work (#1146)
* add info about snippet link resolution * add `langchain_milvus` to refs * correct browser titles for package ref pages * langsmith ref homepage * don't warn on absolute link usage in refs * fix broken links * add note about completions API compat for OpenAI * add OpenRouter callout * formatting * move langgraph errors to folder (and add redirects) * remove deprecated gemini image gen model * grok/groq confusion callout --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent d161ea8 commit 22c8cf0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+943
-679
lines changed

.github/copilot-instructions.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,12 @@ If any code fences like this exist on the code page, then two outputs (one for e
5959

6060
For implementation details, see `pipeline/preprocessors/markdown_preprocessor.py`.
6161

62+
## Snippets
63+
64+
Snippet files in `src/snippets/` are reusable MDX content that can be imported into multiple pages. These snippets undergo special link preprocessing during the build process that converts absolute `/oss/` links to relative paths.
65+
66+
**Important:** When writing links in snippets, be careful about path segments. Read the docstrings and comments in `pipeline/core/builder.py` method `_process_snippet_markdown_file` (lines 807-872) to understand how snippet link preprocessing works and why certain path structures are required.
67+
6268
## Style guide
6369

6470
In general, follow the [Google Developer Documentation Style Guide](https://developers.google.com/style). You can also access this style guide through the [Vale-compatible implementation](https://github.com/errata-ai/Google).

AGENTS.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,12 @@ If any code fences like this exist on the code page, then two outputs (one for e
5959

6060
For implementation details, see `pipeline/preprocessors/markdown_preprocessor.py`.
6161

62+
## Snippets
63+
64+
Snippet files in `src/snippets/` are reusable MDX content that can be imported into multiple pages. These snippets undergo special link preprocessing during the build process that converts absolute `/oss/` links to relative paths.
65+
66+
**Important:** When writing links in snippets, be careful about path segments. Read the docstrings and comments in `pipeline/core/builder.py` method `_process_snippet_markdown_file` (lines 807-872) to understand how snippet link preprocessing works and why certain path structures are required.
67+
6268
## Style guide
6369

6470
In general, follow the [Google Developer Documentation Style Guide](https://developers.google.com/style). You can also access this style guide through the [Vale-compatible implementation](https://github.com/errata-ai/Google).

CLAUDE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,12 @@ If any code fences like this exist on the code page, then two outputs (one for e
5959

6060
For implementation details, see `pipeline/preprocessors/markdown_preprocessor.py`.
6161

62+
## Snippets
63+
64+
Snippet files in `src/snippets/` are reusable MDX content that can be imported into multiple pages. These snippets undergo special link preprocessing during the build process that converts absolute `/oss/` links to relative paths.
65+
66+
**Important:** When writing links in snippets, be careful about path segments. Read the docstrings and comments in `pipeline/core/builder.py` method `_process_snippet_markdown_file` (lines 807-872) to understand how snippet link preprocessing works and why certain path structures are required.
67+
6268
## Style guide
6369

6470
In general, follow the [Google Developer Documentation Style Guide](https://developers.google.com/style). You can also access this style guide through the [Vale-compatible implementation](https://github.com/errata-ai/Google).

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,8 @@
99

1010
> [!IMPORTANT]
1111
>
12-
> * The LangSmith API and [SDK](https://github.com/langchain-ai/langsmith-sdk) references are not yet consolidated to this repo. Visit their documentation:
12+
> * The LangSmith API and [SDK](https://github.com/langchain-ai/langsmith-sdk) references are not yet fully consolidated to this repo. Visit their documentation:
1313
> * [`HTTP API Reference`](https://api.smith.langchain.com/redoc)
14-
> * [`Python SDK reference`](https://docs.smith.langchain.com/reference/python/reference)
1514
> * [`JavaScript/TypeScript SDK reference`](https://docs.smith.langchain.com/reference/js)
1615
1716
---
@@ -156,6 +155,7 @@ These can be used directly using the `Makefile` or via the `docs` CLI tool:
156155
### File formats
157156

158157
* **Markdown files** (`.md`, `.mdx`) - Standard documentation content
158+
* **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.
159159
* **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.
160160
* **Assets** - Images and other files are copied to the build directory
161161

pipeline/core/builder.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -826,7 +826,12 @@ def _process_snippet_markdown_file(
826826

827827
# Convert /oss/ links to relative paths that work from any language context
828828
def convert_oss_link(match: re.Match) -> str:
829-
"""Convert /oss/ links to language-agnostic relative paths."""
829+
"""Convert /oss/ links to language-agnostic relative paths.
830+
831+
IMPORTANT: the conversion creates relative paths that resolve from the
832+
parent page's directory.
833+
- /oss/providers/groq → ../providers/groq
834+
"""
830835
pre = match.group(1) # Everything before the URL
831836
url = match.group(2) # The URL
832837
post = match.group(3) # Everything after the URL

pipeline/preprocessors/link_map.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ class LinkMap(TypedDict):
250250
"host": "https://reference.langchain.com/javascript/",
251251
"scope": "js",
252252
"links": {
253-
"Runtime": "interfaces/_langchain_langgraph.index.Runtime.html",
253+
"Runtime": "modules/langgraph.index.Runtime.html",
254254
"tool": "functions/_langchain_core.tools.tool.html",
255255
"ToolNode": "classes/langchain.index.ToolNode.html",
256256
"UsageMetadata": "types/_langchain_core.messages.UsageMetadata.html",

pipeline/tools/partner_pkg_table.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ def package_row(p: dict) -> str:
161161
f"| {provider} "
162162
f"| [`{p['name']}`]({p['package_url']}) "
163163
f'| <a href="https://pypi.org/project/{p["name"]}/" target="_blank"><img src="https://static.pepy.tech/badge/{p["name"]}/month" alt="Downloads per month" noZoom class="rounded not-prose" /></a> ' # noqa: E501
164-
f'| <a href="https://pypi.org/project/{p["name"]}/" target="_blank"><img src="https://img.shields.io/pypi/v/{p["name"]}?style=flat-square&label=%20&color=orange" alt="PyPI - Latest version" noZoom class="rounded not-prose" /></a> ' # noqa: E501
164+
f'| <a href="https://pypi.org/project/{p["name"]}/" target="_blank"><img src="https://img.shields.io/pypi/v/{p["name"]}?style=flat-square&label=%20" alt="PyPI - Latest version" noZoom class="rounded not-prose" /></a> ' # noqa: E501
165165
f"| {js} |"
166166
)
167167

reference/python/docs/integrations/langchain_milvus.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,4 @@ title: Milvus
88
[![PyPI - License](https://img.shields.io/pypi/l/langchain-milvus)](https://opensource.org/licenses/MIT)
99
[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-milvus)](https://pypistats.org/packages/langchain-milvus)
1010

11-
!!! note
12-
This package ref has not yet been fully migrated to v1.
13-
11+
::: langchain_milvus

reference/python/docs/langchain/langchain/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: LangChain home
3+
---
4+
15
# :simple-langchain:{ .lg .middle } `langchain`
26

37
[![PyPI - Version](https://img.shields.io/pypi/v/langchain?label=%20)](https://pypi.org/project/langchain/#history)

reference/python/docs/langchain_classic/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: LangChain Classic home
3+
---
4+
15
# :fontawesome-solid-building-columns:{ .lg .middle } `langchain-classic`
26

37
[![PyPI - Version](https://img.shields.io/pypi/v/langchain-classic?label=%20)](https://pypi.org/project/langchain-classic/#history)

0 commit comments

Comments
 (0)