docs: refine the Quickstart Part 1 launch-workspace guide#26752
Closed
nickvigilante wants to merge 1 commit into
Conversation
Apply review friction fixes and content updates to docs/tutorials/quickstart/launch-workspace.md: - Convert the browser-warning bullet to a note and consolidate the end-of-step-2 guidance for finding the setup page. - Generalize the template-creation note from "Docker" to a container runtime, tied back to Step 1. - Generalize the template naming step: keep the required `quickstart` name, but stop prescribing a display name and description that drift from the template defaults. - Add a "What's happening behind the scenes?" expandable that explains Coder's Terraform provisioning and links the architecture doc. - Document the Colima socket fix: soften the macOS socket claim in Step 1 and add a troubleshooting step that sets DOCKER_HOST to Colima's socket. - Clarify that Continue with GitHub replaces creating an admin account manually. Screenshot refreshes are tracked separately. Filed via Coder Agents on Nick's behalf. Refs: DOCS-380
Docs preview📖 View docs preview for |
Contributor
Author
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
1 participant
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
Refines Quickstart Part 1 (Launch your first workspace) with friction fixes from a top-down review pass plus content updates. Content-only; no manifest or structural changes.
Changes
> [!NOTE].quickstartname (later parts of the series depend on it), but stop prescribing a display name and description that drift from the template defaults.DOCKER_HOSTat Colima's socket (a real failure hit during the review pass).Stacked on #26712
launch-workspace.mdis introduced by #26712, so this PR targets that branch. It will be retargeted tomainafter #26712 merges.Out of scope (tracked separately)
create-template.pngand the admin-user screenshot) are updated manually.DOCKER_HOSTguidance to the broader install and troubleshooting docs.Filed via Coder Agents on Nick's behalf.