diff --git a/docs/docs/reference/index.md b/docs/docs/reference/index.md index 49b101769..e84688d8b 100644 --- a/docs/docs/reference/index.md +++ b/docs/docs/reference/index.md @@ -11,12 +11,46 @@ search: } - # Reference -Welcome to the LangGraph API reference! This reference provides detailed information about the LangGraph API, including classes, methods, and other components. +Welcome to the LangGraph reference docs! These pages detail the core interfaces you will use when building with LangGraph. Each section covers a different part of the ecosystem. !!! tip - If you are new to LangGraph, we recommend starting with [LangGraph basics](../concepts/why-langgraph.md). + If you are just getting started, see [LangGraph basics](../concepts/why-langgraph.md) for an introduction to the main concepts and usage patterns. + +## LangGraph + +The core APIs for the LangGraph opens source library. + +- [Graphs](graphs.md): Main graph abstraction and usage. +- [Functional API](func.md): Functional programming interface for graphs. +- [Pregel](pregel.md): Pregel-inspired computation model. +- [Checkpointing](checkpoints.md): Saving and restoring graph state. +- [Storage](store.md): Storage backends and options. +- [Types](types.md): Type definitions for graph components. +- [Config](config.md): Configuration options. +- [Errors](errors.md): Error types and handling. +- [Constants](constants.md): Global constants. +- [Channels](channels.md): Message passing and channels. + +## Prebuilt components + +Higher-level abstractions for common workflows, agents, and other patterns. + +- [Agents](agents.md): Built-in agent patterns. +- [Supervisor](supervisor.md): Orchestration and delegation. +- [Swarm](swarm.md): Multi-agent collaboration. +- [MCP Adapters](mcp.md): Integrations with external systems. + +## LangGraph Platform + +Tools for deploying and connecting to the LangGraph Platform. + +- [CLI](../cloud/reference/cli.md): Command-line interface for building and deploying LangGraph Platform applications. +- [Server API](../cloud/reference/api/api_ref.md): REST API for the LangGraph Server. +- [SDK (Python)](../cloud/reference/sdk/python_sdk_ref.md): Python SDK for interacting with instances of the LangGraph Server. +- [SDK (JS/TS)](../cloud/reference/sdk/js_ts_sdk_ref.md): JavaScript/TypeScript SDK for interacting with instances of the LangGraph Server. +- [RemoteGraph](remote_graph.md): `Pregel` abstraction for connecting to LangGraph Server instances. +- [Environment variables](../cloud/reference/env_var.md): Supported configuration variables when deploying with the LangGraph Platform. \ No newline at end of file