Adds a Getting Started Article for VSCode #18
Merged
Conversation
This file contains 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
|
PR failing @AristurtleDev ? |
This reverts commit 5df7acb.
SimonDarksideJ
requested changes
Jun 12, 2024
There was a problem hiding this comment.
A few comments.
- Needs an "Overview" section at the top, like a TOC, to give a high level overview of the process
- I don't think the VSCode Extensions setup needs all three platforms, as VSCOde makes this the same for all platforms (could not see any differences in your writeup)
- For sections that ONLY apply to Mac/Linux, please state that in the header, e.g "Setup Wine For Effect Compilation - MacOS/Linux only)
- Apple Silicon also needs a note about installing both x64 and x86 workloads, as well as paths and environment settings setup. And try not to assume any knowledge about Macs (I was a first time user setting up my Mac for MonoGame and it was MANY tutorials before I found the secret sauce)
- Needs a summary for what the reader should have by the end of the guide, as well as the existing link for "where to go next"
Docfx rendering breaks if all tabbed sections do not contain the same tabs apparently
I've asked @dellis1972 if he can update the document with his known fix of using |
Updated the MacOS Issues documents.
|
Should be good for review now @SimonDarksideJ |
SimonDarksideJ
previously approved these changes
Jun 13, 2024
SimonDarksideJ
approved these changes
Jun 13, 2024
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.
Description
This PR adds a getting started article for setting up a development environment for to use MonoGame with VSCode. The article contains instructions for Windows, macOS, and Linux, each separated using the tabs feature.
Live Preview
A live preview of the article can be found at https://mgdocs.aristurtle.net/articles/getting_started/1_setting_up_your_development_environment_vscode.html
References
Issue MonoGame/docs.monogame.github.io#5: feature request: Add Getting started with VS Code article