docs: updates to README and Deployments section #2372
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
github-actions
bot
added
the
documentation
github-actions
bot
added
documentation
chrismclarke
approved these changes
Aug 21, 2024
|
|
||
| 1. Download and install [Git](https://git-scm.com/downloads) | ||
| This will be used to download the repository | ||
|
|
||
| 2. Download and install [Git LFS](https://git-lfs.github.com/) | ||
| This will be used to download any required binary assets, such as images or pdfs | ||
|
|
||
| 3. Download and install [Node](https://nodejs.org/en/download/) | ||
| This is the programming lanugage required to run the project | ||
| 3. Download and install [Node](https://nodejs.org/en/download/) (choose v18.20.4) |
There was a problem hiding this comment.
nit(non-blocking): not sure how precise we want to be with node version. All our CI uses 18.x, I personally run 20.7.0 (due to known issues for our codebase on higher #2185), so I think could be fine to just suggest
choose v18 or v20
There was a problem hiding this comment.
Yeh, @kwAsant had some general issues running v22, I'm tempted to specify v18 for now
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.
PR Checklist
Description
index.md(this had become out of sync with the README)Git Issues
Closes #
Screenshots/Videos
Intro
Deployments: