[PR #3319] [MERGED] feat: add api reference cross-refs to deep agents docs #3376

Closed
opened 2026-06-05 18:22:54 -04:00 by yindo · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/langchain-ai/docs/pull/3319
Author: @npentrel
Created: 3/26/2026
Status: Merged
Merged: 3/26/2026
Merged by: @npentrel

Base: mainHead: open-swe/cca21eef-ff5f-2ff8-4ebc-5e64e0b8b5d0


📝 Commits (3)

  • 7af0d6e Add API reference cross-refs to Deep Agents docs pages and expand link map with 22 new Deep Agents entries
  • e0367ab update
  • 962b34b update

📊 Changes

9 files changed (+88 additions, -32 deletions)

View changed files

📝 pipeline/preprocessors/link_map.py (+47 -0)
📝 src/oss/deepagents/async-subagents.mdx (+2 -2)
📝 src/oss/deepagents/backends.mdx (+8 -6)
📝 src/oss/deepagents/context-engineering.mdx (+1 -1)
📝 src/oss/deepagents/customization.mdx (+19 -12)
📝 src/oss/deepagents/harness.mdx (+1 -1)
📝 src/oss/deepagents/long-term-memory.mdx (+2 -2)
📝 src/oss/deepagents/sandboxes.mdx (+2 -2)
📝 src/oss/deepagents/subagents.mdx (+6 -6)

📄 Description

Description

Adds cross-references to API reference documentation across Deep Agents docs pages. This includes adding 22 new entries to the link map (19 Python, 3 JS) for Deep Agents classes like SubAgent, CompiledSubAgent, AsyncSubAgent, backend classes, and middleware classes. Cross-references are added to 8 documentation pages using the @[ClassName] syntax, and 2 existing raw reference URLs are converted to use the link map.

Resolves DOC-929

Test Plan

  • Verify cross-reference links resolve correctly in preview deployment
  • Confirm link map test suite passes (19/19 tests pass locally)

Opened collaboratively by Naomi Pentrel and open-swe.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/langchain-ai/docs/pull/3319 **Author:** [@npentrel](https://github.com/npentrel) **Created:** 3/26/2026 **Status:** ✅ Merged **Merged:** 3/26/2026 **Merged by:** [@npentrel](https://github.com/npentrel) **Base:** `main` ← **Head:** `open-swe/cca21eef-ff5f-2ff8-4ebc-5e64e0b8b5d0` --- ### 📝 Commits (3) - [`7af0d6e`](https://github.com/langchain-ai/docs/commit/7af0d6e4e894dae712864b8ae40aaf4cc254f009) Add API reference cross-refs to Deep Agents docs pages and expand link map with 22 new Deep Agents entries - [`e0367ab`](https://github.com/langchain-ai/docs/commit/e0367abcda1b4b09b5ad0707d2d8cdbaefe11368) update - [`962b34b`](https://github.com/langchain-ai/docs/commit/962b34b6c04edb221eed2081721d06ec4c5472c3) update ### 📊 Changes **9 files changed** (+88 additions, -32 deletions) <details> <summary>View changed files</summary> 📝 `pipeline/preprocessors/link_map.py` (+47 -0) 📝 `src/oss/deepagents/async-subagents.mdx` (+2 -2) 📝 `src/oss/deepagents/backends.mdx` (+8 -6) 📝 `src/oss/deepagents/context-engineering.mdx` (+1 -1) 📝 `src/oss/deepagents/customization.mdx` (+19 -12) 📝 `src/oss/deepagents/harness.mdx` (+1 -1) 📝 `src/oss/deepagents/long-term-memory.mdx` (+2 -2) 📝 `src/oss/deepagents/sandboxes.mdx` (+2 -2) 📝 `src/oss/deepagents/subagents.mdx` (+6 -6) </details> ### 📄 Description ## Description Adds cross-references to API reference documentation across Deep Agents docs pages. This includes adding 22 new entries to the link map (19 Python, 3 JS) for Deep Agents classes like `SubAgent`, `CompiledSubAgent`, `AsyncSubAgent`, backend classes, and middleware classes. Cross-references are added to 8 documentation pages using the `@[ClassName]` syntax, and 2 existing raw reference URLs are converted to use the link map. Resolves DOC-929 ## Test Plan - [ ] Verify cross-reference links resolve correctly in preview deployment - [ ] Confirm link map test suite passes (19/19 tests pass locally) _Opened collaboratively by Naomi Pentrel and open-swe._ --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-06-05 18:22:54 -04:00
yindo closed this issue 2026-06-05 18:22:54 -04:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/docs#3376