Fix Codespaces setup steps in tutorial docs - #2
Merged
Conversation
The default Create codespace path never prompts for a dev container config. Split Option A into VS Code and Codespaces paths, and document New with options so users can pick the tutorial configuration. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
🟢 Ready to approve
The documentation changes are consistent across sources/derived READMEs and directly address the stated Codespaces setup failure without introducing correctness or formatting issues.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Pull request overview
Updates the three Python tutorial setup instructions so GitHub Codespaces users explicitly choose the correct dev container configuration (since the default “Create codespace” flow doesn’t prompt for one), preventing setup failures when following the Codespaces path.
Changes:
- Split “Option A” into distinct VS Code (local dev container) and GitHub Codespaces instructions in each tutorial.
- Added explicit Codespaces steps to use New with options… and select the tutorial’s Dev container configuration.
- Regenerated the tutorial
README.mdfiles to match the_index.mdsources.
File summaries
| File | Description |
|---|---|
| tutorials/getting-started/_index.md | Clarifies Codespaces vs local dev container setup for Getting Started. |
| tutorials/getting-started/README.md | Regenerated tutorial README with the updated setup flow. |
| tutorials/building-comfort/_index.md | Clarifies Codespaces vs local dev container setup for Building Comfort. |
| tutorials/building-comfort/README.md | Regenerated tutorial README with the updated setup flow. |
| tutorials/curbside-pickup/_index.md | Clarifies Codespaces vs local dev container setup for Curbside Pickup. |
| tutorials/curbside-pickup/README.md | Regenerated tutorial README with the updated setup flow. |
Review details
- Files reviewed: 6/6 changed files
- Comments generated: 0
- Review effort level: Lite
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
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
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.
The three Python tutorials told users that Codespaces would prompt for a dev container configuration, but the default Create codespace path never does. That made the setup steps fail for anyone following the Codespaces path.
This change splits Option A into separate VS Code and GitHub Codespaces paths. Codespaces users are directed to Code -> Codespaces -> ... -> New with options... and then select the matching tutorial configuration under Dev container configuration.
Updated
_index.mdsources for getting-started, building-comfort, and curbside-pickup, and regenerated the siblingREADME.mdfiles.