docs: clarify setup guide deploys single-node workspace#41
Merged
Conversation
Add an explicit Note callout near the top of the setup guide stating the installer deploys a single-node workspace on one machine, with a pointer to the EKS deployment guide for multi-node setups. Reinforce "one host per workspace" in the Requirements section. Closes #40 Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
👋 Heads-up — Code review queue is at 20 / 8 Above the WIP limit. The team convention is to review existing PRs before opening new work. Open PRs currently in Code review (oldest first):
Pull from review before opening new work. (This is a nudge from the kanban WIP check, not a block.) |
5 tasks
shujaatTracebloc
approved these changes
May 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
<Note>callout at the top of the setup guide making the single-node constraint explicit, with a pointer to the EKS deployment guide for multi-node setups.Previously users had to infer the single-machine deployment from scattered cues ("any modern machine", "local Kubernetes cluster"). This makes it unambiguous.
Closes #40
Test plan
mint devrenders the new Note callout above Requirements/environment-setup/eks-client-deployment-guideresolvesmint broken-linkspasses🤖 Generated with Claude Code
Note
Low Risk
Low risk documentation-only change that clarifies deployment scope; main risk is a potentially incorrect or broken cross-link to the EKS guide.
Overview
Makes the setup guide explicitly state that the installer deploys a single-node, single-machine workspace via a new top-of-page
<Note>callout, and directs users to the/environment-setup/eks-client-deployment-guidefor multi-node/production setups.Updates the Requirements intro to reinforce one host per workspace.
Reviewed by Cursor Bugbot for commit 9f1c381. Bugbot is set up for automated code reviews on this repo. Configure here.