diff --git a/docs/_scripts/copy_notebooks.py b/docs/_scripts/copy_notebooks.py index ff156f0e7..962ece629 100644 --- a/docs/_scripts/copy_notebooks.py +++ b/docs/_scripts/copy_notebooks.py @@ -8,8 +8,8 @@ examples_dir = root_dir / "examples" docs_dir = root_dir / "docs/docs" how_tos_dir = docs_dir / "how-tos" tutorials_dir = docs_dir / "tutorials" -cloud_how_tos_dir = docs_dir / "deploy/how-tos" -cloud_sdk_dir = docs_dir / "deploy" +cloud_how_tos_dir = docs_dir / "cloud/how-tos" +cloud_sdk_dir = docs_dir / "cloud" _MANUAL = { "how-tos": [ diff --git a/docs/docs/deploy/api_concepts.md b/docs/docs/cloud/api_concepts.md similarity index 77% rename from docs/docs/deploy/api_concepts.md rename to docs/docs/cloud/api_concepts.md index 030251396..058464a7f 100644 --- a/docs/docs/deploy/api_concepts.md +++ b/docs/docs/cloud/api_concepts.md @@ -2,12 +2,12 @@ This page discusses high-level concepts of the LangGraph Cloud. ## Assistant -An assistant is a configured instance of a [`CompiledGraph`](../../reference/graphs/#compiledgraph). It abstracts the cognitive architecture of the graph and contains instance specific configuration and metadata. Multiple assistants can reference the same graph but can contain different configuration and metadata, which may differentiate the behavior of the assistants. +An assistant is a configured instance of a [`CompiledGraph`](../reference/graphs/#compiledgraph). It abstracts the cognitive architecture of the graph and contains instance specific configuration and metadata. Multiple assistants can reference the same graph but can contain different configuration and metadata, which may differentiate the behavior of the assistants. An assistant (i.e. the graph) is invoked as part of a [run](#run). ## Thread -A thread contains the accumulated state of a group of [runs](#run). If a run is executed on a thread, then the [state](../../concepts/#state-management) of the underlying graph of the [assistant](#assistant) will be persisted to the thread. A thread's current and historical state can be retrieved. +A thread contains the accumulated state of a group of [runs](#run). If a run is executed on a thread, then the [state](../concepts/#state-management) of the underlying graph of the [assistant](#assistant) will be persisted to the thread. A thread's current and historical state can be retrieved. To persist state, a thread must be created prior to executing a run. diff --git a/docs/docs/deploy/deployment/img/api_page.png b/docs/docs/cloud/deployment/img/api_page.png similarity index 100% rename from docs/docs/deploy/deployment/img/api_page.png rename to docs/docs/cloud/deployment/img/api_page.png diff --git a/docs/docs/deploy/deployment/img/deploy_filled_out.png b/docs/docs/cloud/deployment/img/deploy_filled_out.png similarity index 100% rename from docs/docs/deploy/deployment/img/deploy_filled_out.png rename to docs/docs/cloud/deployment/img/deploy_filled_out.png diff --git a/docs/docs/deploy/deployment/img/deployed_page.png b/docs/docs/cloud/deployment/img/deployed_page.png similarity index 100% rename from docs/docs/deploy/deployment/img/deployed_page.png rename to docs/docs/cloud/deployment/img/deployed_page.png diff --git a/docs/docs/deploy/deployment/img/deployment_page.png b/docs/docs/cloud/deployment/img/deployment_page.png similarity index 100% rename from docs/docs/deploy/deployment/img/deployment_page.png rename to docs/docs/cloud/deployment/img/deployment_page.png diff --git a/docs/docs/deploy/deployment/img/graph_visualization.png b/docs/docs/cloud/deployment/img/graph_visualization.png similarity index 100% rename from docs/docs/deploy/deployment/img/graph_visualization.png rename to docs/docs/cloud/deployment/img/graph_visualization.png diff --git a/docs/docs/deploy/deployment/managed.md b/docs/docs/cloud/deployment/managed.md similarity index 100% rename from docs/docs/deploy/deployment/managed.md rename to docs/docs/cloud/deployment/managed.md diff --git a/docs/docs/deploy/deployment/self_hosted.md b/docs/docs/cloud/deployment/self_hosted.md similarity index 100% rename from docs/docs/deploy/deployment/self_hosted.md rename to docs/docs/cloud/deployment/self_hosted.md diff --git a/docs/docs/deploy/index.md b/docs/docs/cloud/index.md similarity index 100% rename from docs/docs/deploy/index.md rename to docs/docs/cloud/index.md diff --git a/docs/docs/deploy/quick_start.md b/docs/docs/cloud/quick_start.md similarity index 100% rename from docs/docs/deploy/quick_start.md rename to docs/docs/cloud/quick_start.md diff --git a/docs/docs/deploy/reference/api_ref.md b/docs/docs/cloud/reference/api_ref.md similarity index 100% rename from docs/docs/deploy/reference/api_ref.md rename to docs/docs/cloud/reference/api_ref.md diff --git a/docs/docs/deploy/reference/cli.md b/docs/docs/cloud/reference/cli.md similarity index 100% rename from docs/docs/deploy/reference/cli.md rename to docs/docs/cloud/reference/cli.md diff --git a/docs/docs/deploy/reference/sdk/js_ts_sdk_ref.md b/docs/docs/cloud/reference/sdk/js_ts_sdk_ref.md similarity index 100% rename from docs/docs/deploy/reference/sdk/js_ts_sdk_ref.md rename to docs/docs/cloud/reference/sdk/js_ts_sdk_ref.md diff --git a/docs/docs/deploy/reference/sdk/python_sdk_ref.md b/docs/docs/cloud/reference/sdk/python_sdk_ref.md similarity index 100% rename from docs/docs/deploy/reference/sdk/python_sdk_ref.md rename to docs/docs/cloud/reference/sdk/python_sdk_ref.md diff --git a/docs/docs/deploy/sdk/img/graph_diagram.png b/docs/docs/cloud/sdk/img/graph_diagram.png similarity index 100% rename from docs/docs/deploy/sdk/img/graph_diagram.png rename to docs/docs/cloud/sdk/img/graph_diagram.png diff --git a/docs/docs/deploy/sdk/img/thread_diagram.png b/docs/docs/cloud/sdk/img/thread_diagram.png similarity index 100% rename from docs/docs/deploy/sdk/img/thread_diagram.png rename to docs/docs/cloud/sdk/img/thread_diagram.png diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 696edb883..8276b0939 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -166,37 +166,37 @@ nav: - Prebuilt Components: reference/prebuilt.md - Errors: reference/errors.md - 'Cloud (alpha)': - - 'deploy/index.md' + - 'cloud/index.md' - Tutorials: - - Quick Start: 'deploy/quick_start.md' - - SDK: - - Python: 'deploy/sdk/python_sdk.ipynb' - - JS/TS: 'deploy/sdk/js_sdk.ipynb' - - Deployment: - - Self-Hosted: 'deploy/deployment/self_hosted.md' - - Managed: 'deploy/deployment/managed.md' + - Quick Start: 'cloud/quick_start.md' + - SDK: + - Python: 'cloud/sdk/python_sdk.ipynb' + - JS/TS: 'cloud/sdk/js_sdk.ipynb' + - Deployment: + - Self-Hosted: 'cloud/deployment/self_hosted.md' + - Managed: 'cloud/deployment/managed.md' - How-to Guides: - Streaming: - - Stream Messages: 'deploy/how-tos/cloud_examples/stream_messages.ipynb' - - Stream Values: 'deploy/how-tos/cloud_examples/stream_values.ipynb' - - Stream Updates: 'deploy/how-tos/cloud_examples/stream_updates.ipynb' + - Stream Messages: 'cloud/how-tos/cloud_examples/stream_messages.ipynb' + - Stream Values: 'cloud/how-tos/cloud_examples/stream_values.ipynb' + - Stream Updates: 'cloud/how-tos/cloud_examples/stream_updates.ipynb' - Double Texting: - - Interrupt: 'deploy/how-tos/cloud_examples/interrupt_concurrent.ipynb' - - Rollback: 'deploy/how-tos/cloud_examples/rollback_concurrent.ipynb' - - Reject: 'deploy/how-tos/cloud_examples/reject_concurrent.ipynb' - - Enqueue: 'deploy/how-tos/cloud_examples/enqueue_concurrent.ipynb' - - Run Agent in Background: 'deploy/how-tos/cloud_examples/background_run.ipynb' - - Run Multiple Agents in Thread: 'deploy/how-tos/cloud_examples/same-thread.ipynb' - - Human in the loop: 'deploy/how-tos/cloud_examples/human-in-the-loop_cloud.ipynb' - - Create Agents with Configuration: 'deploy/how-tos/cloud_examples/configuration_cloud.ipynb' + - Interrupt: 'cloud/how-tos/cloud_examples/interrupt_concurrent.ipynb' + - Rollback: 'cloud/how-tos/cloud_examples/rollback_concurrent.ipynb' + - Reject: 'cloud/how-tos/cloud_examples/reject_concurrent.ipynb' + - Enqueue: 'cloud/how-tos/cloud_examples/enqueue_concurrent.ipynb' + - Run Agent in Background: 'cloud/how-tos/cloud_examples/background_run.ipynb' + - Run Multiple Agents in Thread: 'cloud/how-tos/cloud_examples/same-thread.ipynb' + - Human in the loop: 'cloud/how-tos/cloud_examples/human-in-the-loop_cloud.ipynb' + - Create Agents with Configuration: 'cloud/how-tos/cloud_examples/configuration_cloud.ipynb' - Conceptual Guides: - - API Concepts: 'deploy/api_concepts.md' + - API Concepts: 'cloud/api_concepts.md' - Reference: - - API: 'deploy/reference/api_ref.md' - - SDK: - - Python: 'deploy/reference/sdk/python_sdk_ref.md' - - JS/TS: 'deploy/reference/sdk/js_ts_sdk_ref.md' - - CLI: 'deploy/reference/cli.md' + - API: 'cloud/reference/api_ref.md' + - SDK: + - Python: 'cloud/reference/sdk/python_sdk_ref.md' + - JS/TS: 'cloud/reference/sdk/js_ts_sdk_ref.md' + - CLI: 'cloud/reference/cli.md' markdown_extensions: