[PR #779] [MERGED] docs: Create JS/TS SDK reference page #1667

Closed
opened 2026-02-20 17:45:16 -05:00 by yindo · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/langchain-ai/langgraph/pull/779
Author: @andrewnguonly
Created: 6/23/2024
Status: Merged
Merged: 6/23/2024
Merged by: @andrewnguonly

Base: mainHead: an/23jun/js-ts-sdk-docs


📝 Commits (2)

  • d3ec367 Create JS/TS SDK reference docs.
  • 384cb36 Remove index.mts from typedoc entry point.

📊 Changes

6 files changed (+4224 additions, -4 deletions)

View changed files

📝 docs/docs/cloud/reference/sdk/js_ts_sdk_ref.md (+2361 -2)
📝 libs/sdk-js/.gitignore (+1 -0)
📝 libs/sdk-js/README.md (+17 -1)
📝 libs/sdk-js/package.json (+3 -0)
📝 libs/sdk-js/tsconfig.json (+10 -1)
📝 libs/sdk-js/yarn.lock (+1832 -0)

📄 Description

Summary

typedoc is used to generate documentation for the public entry points of the JS/TS SDK and concat-md is used to consolidate the documentation files into a single markdown file. This is done for simplicity; it keeps the MkDocs navigation simple.

This approach isn't ideal (the docs aren't easily customizable and they don't look amazing), but it's a starting point and gets the job done. Minimal effort to generate docs and all important classes, interfaces, and types are documented with references back to the source code.


🔄 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/langgraph/pull/779 **Author:** [@andrewnguonly](https://github.com/andrewnguonly) **Created:** 6/23/2024 **Status:** ✅ Merged **Merged:** 6/23/2024 **Merged by:** [@andrewnguonly](https://github.com/andrewnguonly) **Base:** `main` ← **Head:** `an/23jun/js-ts-sdk-docs` --- ### 📝 Commits (2) - [`d3ec367`](https://github.com/langchain-ai/langgraph/commit/d3ec367566bf3d5c58b8150f1d8208e8b21e6144) Create JS/TS SDK reference docs. - [`384cb36`](https://github.com/langchain-ai/langgraph/commit/384cb3647edf00048dd9addd1a422d0e1b69c738) Remove index.mts from typedoc entry point. ### 📊 Changes **6 files changed** (+4224 additions, -4 deletions) <details> <summary>View changed files</summary> 📝 `docs/docs/cloud/reference/sdk/js_ts_sdk_ref.md` (+2361 -2) 📝 `libs/sdk-js/.gitignore` (+1 -0) 📝 `libs/sdk-js/README.md` (+17 -1) 📝 `libs/sdk-js/package.json` (+3 -0) 📝 `libs/sdk-js/tsconfig.json` (+10 -1) 📝 `libs/sdk-js/yarn.lock` (+1832 -0) </details> ### 📄 Description ### Summary `typedoc` is used to generate documentation for the public entry points of the JS/TS SDK and `concat-md` is used to consolidate the documentation files into a single markdown file. This is done for simplicity; it keeps the MkDocs navigation simple. This approach isn't ideal (the docs aren't easily customizable and they don't look amazing), but it's a starting point and gets the job done. Minimal effort to generate docs and all important classes, interfaces, and types are documented with references back to the source code. --- <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-20 17:45:16 -05:00
yindo closed this issue 2026-02-20 17:45:16 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/langgraph#1667