langchain-ai/docs
1
0
Fork 0
mirror of https://github.com/langchain-ai/docs.git synced 2026-07-19 16:33:35 -04:00
Code Issues 490 Packages Projects Releases Wiki Activity

[PR #640] [MERGED] feat: reference docs #883

New Issue
Closed
opened 2026-02-17 17:21:18 -05:00 by yindo · 0 comments
yindo commented 2026-02-17 17:21:18 -05:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/langchain-ai/docs/pull/640
Author: @hntrl
Created: 9/23/2025
Status: ✅ Merged
Merged: 9/24/2025
Merged by: @eyurtsev

Base: main ← Head: hunter/references

📝 Commits (7)

📊 Changes

23 files changed (+5300 additions, -2 deletions)

View changed files

📝 .editorconfig (+1 -1)
📝 Makefile (+14 -1)
📝 README.md (+3 -0)
➕ reference/.gitignore (+1 -0)
➕ reference/javascript/.eslintignore (+5 -0)
➕ reference/javascript/.eslintrc.cjs (+18 -0)
➕ reference/javascript/.gitignore (+11 -0)
➕ reference/javascript/.prettierignore (+6 -0)
➕ reference/javascript/.prettierrc (+9 -0)
➕ reference/javascript/build.ts (+513 -0)
➕ reference/javascript/eslint.config.mjs (+22 -0)
➕ reference/javascript/package.json (+26 -0)
➕ reference/javascript/pnpm-lock.yaml (+1577 -0)
➕ reference/javascript/tsconfig.json (+114 -0)
➕ reference/package.json (+17 -0)
➕ reference/pnpm-lock.yaml (+2800 -0)
➕ reference/python/Makefile (+4 -0)
➕ reference/python/README.md (+5 -0)
➕ reference/python/__init__.py (+1 -0)
➕ reference/python/__main__.py (+14 -0)

...and 3 more files

📄 Description

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 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
  • 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

🔄 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/640 **Author:** [@hntrl](https://github.com/hntrl) **Created:** 9/23/2025 **Status:** ✅ Merged **Merged:** 9/24/2025 **Merged by:** [@eyurtsev](https://github.com/eyurtsev) **Base:** `main` ← **Head:** `hunter/references` --- ### 📝 Commits (7) - [`084b3a2`](https://github.com/langchain-ai/docs/commit/084b3a219904ec3a2d9ddd273678d7d51dbceede) feat: reference docs - [`783b1c2`](https://github.com/langchain-ai/docs/commit/783b1c26e180ddbb4142d3bc35cadbf45a2bdd78) cr - [`d04c4df`](https://github.com/langchain-ai/docs/commit/d04c4dffd21bd5beb9bea10936f30540a09f7700) cr - [`a367575`](https://github.com/langchain-ai/docs/commit/a367575eab3d0f4e897562a6c4f8b76ee4c0dddf) cr - [`1524c8c`](https://github.com/langchain-ai/docs/commit/1524c8cbf3b148f969351b54bb49dedbd0fb6a8c) cr - [`e0dd1bf`](https://github.com/langchain-ai/docs/commit/e0dd1bfc241c69a57b8722410ff4a7a1ffc07305) cr - [`409b335`](https://github.com/langchain-ai/docs/commit/409b3350f9ee985b4715e31d795080daf0e7063f) fmt ### 📊 Changes **23 files changed** (+5300 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `.editorconfig` (+1 -1) 📝 `Makefile` (+14 -1) 📝 `README.md` (+3 -0) ➕ `reference/.gitignore` (+1 -0) ➕ `reference/javascript/.eslintignore` (+5 -0) ➕ `reference/javascript/.eslintrc.cjs` (+18 -0) ➕ `reference/javascript/.gitignore` (+11 -0) ➕ `reference/javascript/.prettierignore` (+6 -0) ➕ `reference/javascript/.prettierrc` (+9 -0) ➕ `reference/javascript/build.ts` (+513 -0) ➕ `reference/javascript/eslint.config.mjs` (+22 -0) ➕ `reference/javascript/package.json` (+26 -0) ➕ `reference/javascript/pnpm-lock.yaml` (+1577 -0) ➕ `reference/javascript/tsconfig.json` (+114 -0) ➕ `reference/package.json` (+17 -0) ➕ `reference/pnpm-lock.yaml` (+2800 -0) ➕ `reference/python/Makefile` (+4 -0) ➕ `reference/python/README.md` (+5 -0) ➕ `reference/python/__init__.py` (+1 -0) ➕ `reference/python/__main__.py` (+14 -0) _...and 3 more files_ </details> ### 📄 Description 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 --- <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-02-17 17:21:18 -05:00
yindo closed this issue 2026-02-17 17:21:18 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
deepagents
docs-infra
external
external
help wanted
integration
internal
internal
javascript
js/ts
langchain
langgraph
langsmith
needs-title
pull-request
Mirrored from GitHub Pull Request
 python
reference
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/docs#883
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?