-
Notifications
You must be signed in to change notification settings - Fork 614
nits: lgp prose #639
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
nits: lgp prose #639
Conversation
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.
Pull Request Overview
This PR makes minor editorial improvements to the LangGraph Platform documentation by shortening sidebar titles and group names for better readability and navigation. The changes focus on making the interface more concise while maintaining clarity.
Key Changes
- Shortened sidebar titles for deployment and setup documentation pages
- Abbreviated navigation group names in the docs configuration
- Fixed a typo in one of the sidebar titles
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/langgraph-platform/use-remote-graph.mdx | Shortened sidebar title from "Interact with a deployment using RemoteGraph" to "Interact using RemoteGraph" |
| src/langgraph-platform/setup-pyproject.mdx | Shortened sidebar title to "With pyproject.toml" |
| src/langgraph-platform/setup-app-requirements-txt.mdx | Shortened sidebar title to "With requirements.txt" |
| src/langgraph-platform/deploy-to-cloud.mdx | Changed sidebar title from "Deploy to cloud" to "Cloud deployment" |
| src/langgraph-platform/deploy-standalone-server.mdx | Shortened sidebar title to "Self-hosted standalone server" |
| src/langgraph-platform/deploy-self-hosted-full-platform.mdx | Shortened sidebar title to "Self-hosted full platform" |
| src/langgraph-platform/deploy-hybrid.mdx | Shortened sidebar title to "Hybrid delpoyment" (contains typo) |
| src/docs.json | Updated navigation group name from "Configure your application for deployment" to "Configure app for deployment" |
|
Preview ID generated: preview-mdrxyl-1758666957-cccf367 |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
Pull Request Overview
Copilot reviewed 8 out of 8 changed files in this pull request and generated no new comments.
|
Preview ID generated: preview-mdrxyl-1758685867-8dde1e5 |
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'm cool with these changes. Couple of comments. Upcoming platform doc changes for LGP/LS may change a lot of this though.
Thanks for making these changes and reducing sidebar clutter!
| "langgraph-platform/deploy-self-hosted-full-platform", | ||
| "langgraph-platform/deploy-standalone-server", | ||
| "langgraph-platform/use-remote-graph" | ||
| ] |
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'm ok with these changes — maybe change this group title to "Deployment guides"
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 like the shorter variant if it helps :)
| --- | ||
| title: How to deploy hybrid | ||
| sidebarTitle: Deploy hybrid | ||
| sidebarTitle: Hybrid 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.
If we're going with minimal in the sidebar, maybe Cloud and Hybrid can just drop "deployment" from their sidebarTitle
| --- | ||
| title: How to interact with a deployment using RemoteGraph | ||
| sidebarTitle: Interact with a deployment using RemoteGraph | ||
| sidebarTitle: Interact using RemoteGraph |
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 actually think we should keep the previous version for this one. We had some comments that users and internal folks didn't feel it was immediately obvious what RemoteGraph was. So, "with a deployment" seems to provide a bit of extra context that may help.
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.
Pull Request Overview
Copilot reviewed 7 out of 7 changed files in this pull request and generated no new comments.
|
Preview ID generated: preview-mdrxyl-1758746816-2872c1b |
no offense taken if disagree with these