-
Notifications
You must be signed in to change notification settings - Fork 112
WIP Draft nav + sidebar updates for langsmith platform #651
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Preview ID generated: preview-langsm-1758824315-b51cbe2 |
5e4ccf1
to
5c53ec5
Compare
Preview ID generated: preview-langsm-1759174519-2fcf987 |
Preview ID generated: preview-langsm-1759176996-f20be3d |
e8aab3b
to
9c76609
Compare
Preview ID generated: preview-langsm-1759342075-296f79d |
a7896cd
to
1fa67c3
Compare
Preview ID generated: preview-langsm-1759351956-78e92d8 |
1fa67c3
to
1c19df5
Compare
0c08343
to
6e19883
Compare
Preview ID generated: preview-langsm-1759438309-4bf2e07 |
6e19883
to
67e123b
Compare
Preview ID generated: preview-langsm-1759495425-7827e03 |
67e123b
to
4eb0e2b
Compare
Preview ID generated: preview-langsm-1759498954-167ce7c |
Preview ID generated: preview-langsm-1759500119-896821e |
b2876e5
to
11305b3
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
First, thanks for working on these changes, @katmayb. Here are my latest high-level thoughts that don't apply directly to any specific change in this PR, but is broadly relevant to the overall restructuring.
- I couldn't look at every change in the PR. It's too big.
- I understand that the primary goal of this PR is to accommodate the product renaming/consolidation and information restructuring. There are some places where I've commented on specific content changes, so feel free to ignore these comments if it's easier to address these in a separate PR.
- It might be nice to create some kind of informational banner/page that describes what changes have been made; a doc for the doc changes.
- Creating a new
Hosting
tab feels like the right direction. However, I think it's still challenging to understand that there are different "modules" within LangSmith and that there are different ways to enable/disable them. I will provide some suggestions/ideas for how we could make the content more clear outside of this PR. We may have to make these changes after the launch.
src/langsmith/deployments.mdx
Outdated
|
||
This section covers how to package, build, and deploy your _agents_ and applications. | ||
|
||
_Deployment_ focuses on how to build and deploy your graphs (or agentic workflows) as [LangGraph Servers](/langsmith/langgraph-server). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since LangSmith Deployment
literally only supports building and deploying LangGraph OSS
graphs, I'd be fine with being more specific/precise here: Deployment focuses on how to build and deploy your LangGraph graphs as LangGraph Servers.
Not blocking.
Side bar: I'm really averse to using "agentic workflows" here because there's been so much discussion/controversy around naming and definitions of things (e.g. OpenAI Dev Day Agent Builder release, Harrison's follow-up blog post). Because of the quickly evolving nature of these things, my preference is that our documentation is dumb and simple and decoupled from this noise. For example, in 6 months, "agentic workflows" might mean something else and/or there will be a new term: "agentic work streams".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is a good point. I removed this instance of "agentic workflows". It would be worthwhile to do a bit of a follow-up on this — I want the docs terminology to be as clear and relevant for as long as possible.
title: Run a LangGraph application locally | ||
sidebarTitle: Run a LangGraph application locally | ||
title: Run a LangGraph app locally | ||
sidebarTitle: Run a LangGraph app locally |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: To be consistent with the new hosting.mdx
page, LangGraph app
--> LangGraph Server
title: Run a LangGraph Server locally
sidebarTitle: Run a LangGraph Server locally
There are other places where we use the term app
, LangGraph app
, and LangGraph application
, and LangSmith application
. For consistency, should we change all instances to LangGraph Server
? I won't comment on all places in this PR. Also, this can probably be done as part of a different PR.
Side bar: I won't comment in all places, but we seem to be using LangGraph Server
and LangSmith application
interchangeably in the new docs. This is increasing the confusion IMHO. Can we only use 1 term?
Side, side bar: Do we need a Glossary of Terms
page? This might be helpful.
src/docs.json
Outdated
] | ||
}, | ||
{ | ||
"group": "Platform components", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: Platform components
--> Deployment components
The items under this section are only for LangSmith Deployment
. Platform
feels too wide/vague (for now).
``` | ||
|
||
You can find your project & tenant IDs with a GET request to the `/info` endpoint on your LangGraph Platform deployment. | ||
You can find your project & tenant IDs with a GET request to the `/info` endpoint on your LangSmith deployment. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit, but maybe disregard this comment: project & tenant IDs
--> deployment (project_id) & workspace IDs (tenant_id)
A long time ago, we used to call deployments, "projects" and we used to call workspaces, "tenants". We never updated the GET /info
endpoint. Source code:
async def meta_info(request: ApiRequest):
plus = plus_features_enabled()
return JSONResponse(
{
"version": __version__,
"langgraph_py_version": langgraph.version.__version__,
"flags": {
"assistants": True,
"crons": plus and config.FF_CRONS_ENABLED,
"langsmith": bool(config.LANGSMITH_CONTROL_PLANE_API_KEY)
and bool(config.TRACING),
"langsmith_tracing_replicas": True,
},
"host": {
"kind": metadata.HOST,
"project_id": metadata.PROJECT_ID,
"host_revision_id": metadata.HOST_REVISION_ID,
"revision_id": metadata.REVISION,
"tenant_id": metadata.TENANT_ID,
},
}
)
89630f5
to
7592722
Compare
Preview ID generated: preview-langsm-1760447342-72c9244 |
7592722
to
4293425
Compare
Preview ID generated: preview-langsm-1760450868-be36abc |
Preview ID generated: preview-langsm-1760451311-f04e2be |
This PR updates the docs for LangSmith Platform, folding in LGP. Specifically: - Update to tab arrangement. - Big content changes in Deployments tab (now Agent deployment as well as Platform infrastructure deployment). - Changing the name of the Studio feature. - Overhaul of home page. - Updates to tab landing pages to follow the same card format consistently. - Moving LGP content into the LS directory in the docs. ## Latest preview: https://langchain-5e9cc07a-preview-langsm-1760109143-df9b7ef.mintlify.app/langsmith/home
This PR updates the docs for LangSmith Platform, folding in LGP. Specifically:
Latest preview:
https://langchain-5e9cc07a-preview-langsm-1760109143-df9b7ef.mintlify.app/langsmith/home