docs: Add VS Code WSL extension install step for dev env setup #8314
Conversation
…ment setup guide (cvat-ai#8313) - This commit adds a step to the CVAT development setup guide for users working with WSL (Windows Subsystem for Linux). The added instruction guides users to install the VS Code extension for WSL, ensuring that Visual Studio Code opens correctly inside the WSL environment. - This change addresses an issue where users might encounter a 'DEBUG STOPPED' error if the extension is not installed, improving the overall setup experience. - Related to issue cvat-ai#8313.
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThis update introduces a clear instruction for installing a Visual Studio Code extension tailored for the Windows Subsystem for Linux (WSL). By including this step, the documentation enhances user experience during the development environment setup, ensuring that users have the necessary tools for a seamless workflow. The overall structure of the document remains organized, integrating this vital information smoothly into the existing content. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- site/content/en/docs/contributing/development-environment.md (1 hunks)
Files skipped from review due to trivial changes (1)
- site/content/en/docs/contributing/development-environment.md
smit9924
changed the title
smit9924
changed the title
smit9924
changed the title
smit9924
changed the title
smit9924
changed the title
|
@azhavoro can you please guide me know why Linter check fails. As much I understand is commit message has length more than 72 characters which I fixed. Now its showing me something like this "237:211 warning Line must be at most 120 characters maximum-line-length remark-lint. Can you please kindly guide me. |
Fixed the issue of lines exceeding the 120-character limit by splitting them into separate lines. Added a step to install the VS Code WSL extension in the development environment setup documentation. Co-authored-by: Andrey Zhavoronkov <andrey@cvat.ai>
|
|
Thanks for the contribution! |
This commit adds a step to the CVAT development setup guide for users working with WSL (Windows Subsystem for Linux). The added instruction guides users to install the VS Code extension for WSL, ensuring that Visual Studio Code opens correctly inside the WSL environment.
This change addresses an issue where users might encounter a 'DEBUG STOPPED' error if the extension is not installed, improving the overall setup experience.
Related to issue Debug stopped while try to run server: debug #8313.
Motivation and context
How has this been tested?
Checklist
developbranch(cvat-canvas,
cvat-core,
cvat-data and
cvat-ui)
License
Feel free to contact the maintainers if that's a concern.
Summary by CodeRabbit