docs: Clean up quick start steps for editing the task #114
Conversation
docs/quick_start.mdx
Outdated
| Now that the task is up and running we can make our first changes to the code! We'll edit the `package.json` file to reflect your information. | ||
| Now that the project is up and running we can make our first changes to the code! | ||
|
|
||
| ### 1) Edit the Project Metadata | ||
|
|
||
| 1. Create a new branch |
There was a problem hiding this comment.
Do you need to specify that this command is run in the Terminal and without killing the server?
There was a problem hiding this comment.
I mean, you could rerun it, but maybe folks need to be reminded that the server needs to be running constantly or else the app will close?
There was a problem hiding this comment.
I think it's okay to leave it as is. Either closing the server and changing branches or changing branches in a new terminal will work. We document that the npm run dev will reflect the changes immediately so whether or not they keep it running is up to them
There was a problem hiding this comment.
I updated the text to say "Create a new branch in a separate terminal" which should help a little
| ``` | ||
|
|
||
| 4. Create a [pull request](version_control#create-a-pull-request) to bring your changes into the `main` branch | ||
| 10. Create and merge a [pull request](version_control#create-a-pull-request) to merge your changes into the `main` branch. Make sure the builds complete successfully before merging! |
There was a problem hiding this comment.
Do you want to give instructions on what it means to make sure the build completes successfully?
There was a problem hiding this comment.
The builds are run as github actions and I think GitHub makes it pretty self explanatory if/when the actions fail and how to diagnose the issues. I'm toying around with the idea of writing a seperate GitHub Discussions post for working with the actions but I don't think that needs to be up before 3.3 gets released
Co-authored-by: Galen Winsor <[email protected]>
Co-authored-by: Galen Winsor <[email protected]>
Updates the quick start guide! Lots more screenshots I do apologize.
experiment/index.jsfilestartProcedureandendProcedureto the new task