[DOCS] Make compiling guide more user friendly #2813
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
Moved “download Git” from the middle of the guide to the setup step Should prevent errors with Git before installing Git
trayfellow
approved these changes
Jun 15, 2024
|
I think it could also be good adding that users should not download the repository from the Download ZIP button, since I've seen a couple of cases where people would do that and compilation would fail. |
Each step should be easier to follow with this structure
Hundrec
changed the title
|
Great suggestion! I've added the ZIP button warning in the Setup step and restructured sentences to be easier to read and follow. |
|
Nice! Merging directly into |
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.
Moved “download Git” from the middle of the guide to the setup step
Should prevent errors with Git before installing Git