docs: clarify dev container scope#5581
Open
zhouzhou626 wants to merge 1 commit into
Open
Conversation
Signed-off-by: zhouzhou626 <255877794+zhouzhou626@users.noreply.github.com>
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.
Fixes
Fixes #2937 by @sarayourfriend
Description
Adds a note near the top of the general setup guide explaining that VS Code's
.devcontainer/devcontainer.jsonprompt should not be used for local setup. The note clarifies that the dev container configuration is intended and tested for GitHub Codespaces, specifically for frontend and documentation contributions, while local development should useovdirectly.Testing Instructions
Documentation-only change. I verified the changed file with:
git diff --check rg -n "dev container configuration|GitHub Codespaces|VS Code detects" documentation/general/general_setup.mdI did not run the full documentation build because this local environment does not have the project's
pdmorjusttooling installed.Checklist
Update index.md).main) or a parent feature branch.ov just catalog/generate-docsfor catalogPRs) or the media properties generator (
ov just catalog/generate-docs media-propsfor the catalog or
ov just api/generate-docsfor the API) where applicable.Developer Certificate of Origin
Developer Certificate of Origin