updating documentation for ticket #11443 #12153
Merged
+16
−4
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
I updated the instructions and included build instructions in the quickstart, i included the build in the build the code section before start. It was crucial so the build is ran first.
The change solves several potential problems:
Prevents Server Crashes: By ensuring that the npm run build command is run, all necessary files are generated before starting the server, preventing crashes or errors related to missing files.
Ensures Correct Asset Processing: It guarantees that all assets, such as GLSL shaders, are properly processed and available in their required formats, avoiding runtime issues and improving the reliability of the development server.
Provides a Clear Development Workflow: Adding the build step to the "Quickstart" section creates a clear and repeatable development process. This helps new developers or contributors quickly get up to speed and reduces confusion about the necessary setup steps.
Improves Documentation: Including the build step in the documentation ensures that it aligns with the actual development workflow and best practices. This helps avoid discrepancies between the documented process and the required steps to successfully run the project.
Issue number and link
##11443
Testing plan
Author checklist
CONTRIBUTORS.md
CHANGES.md
with a short summary of my change