Skip to content

docs: clarify setup guide deploys single-node workspace#42

Merged
saadqbal merged 1 commit into
mainfrom
docs/clarify-single-node-setup
May 18, 2026
Merged

docs: clarify setup guide deploys single-node workspace#42
saadqbal merged 1 commit into
mainfrom
docs/clarify-single-node-setup

Conversation

@saadqbal
Copy link
Copy Markdown
Contributor

@saadqbal saadqbal commented May 18, 2026

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

Summary

Related

Type of change

  • Feature
  • Bug fix
  • Tech-debt / refactor
  • Docs
  • Security / hardening
  • Breaking change

Test plan

Screenshots / recordings

Deployment notes

Checklist

  • Tests added / updated and passing locally
  • Docs updated if behavior or config changed
  • No secrets / credentials in the diff
  • For security-sensitive paths: appropriate reviewer requested

Note

Low Risk
Low risk documentation-only change that adds a callout and minor wording clarification with no runtime impact.

Overview
Adds a top-of-page Note in environment-setup/setup-guide.mdx explicitly stating the installer deploys a single-node workspace on one machine and links to the EKS deployment guide for multi-node/production setups.

Updates the Requirements intro to reinforce the one host per workspace expectation.

Reviewed by Cursor Bugbot for commit 9f1c381. Bugbot is set up for automated code reviews on this repo. Configure here.

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>
@saadqbal saadqbal self-assigned this May 18, 2026
@LukasWodka
Copy link
Copy Markdown
Contributor

👋 Heads-up — Code review queue is at 21 / 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.)

@saadqbal saadqbal merged commit 7511111 into main May 18, 2026
12 of 15 checks passed
@divyasinghds divyasinghds deleted the docs/clarify-single-node-setup branch May 21, 2026 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: clarify setup guide deploys single-node workspace

3 participants