update build flag tip #557
Merged
Conversation
This file contains hidden or 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
improve wording
nhussein11
reviewed
Apr 14, 2025
| @@ -74,7 +74,7 @@ The [Polkadot SDK Parachain Template](https://github.com/paritytech/polkadot-sdk | |||
| ``` | |||
|
|
|||
| !!!tip | |||
| Initial compilation may take several minutes, depending on your machine specifications. Always use the `--release` flag to build optimized, production-ready artifacts. | |||
| Initial compilation may take several minutes, depending on your machine specifications. Use the `--release` flag to build binaries with improved runtime performance compared to a ``--debug`` build. | |||
There was a problem hiding this comment.
Hey @PieWol , thank you very much for this contribution. Just a minor visual detail here:
Suggested change
| Initial compilation may take several minutes, depending on your machine specifications. Use the `--release` flag to build binaries with improved runtime performance compared to a ``--debug`` build. | |
| Initial compilation may take several minutes, depending on your machine's specifications. Use the `--release` flag to build binaries with improved runtime performance compared to a `--debug` build. |
Also, could you please run:
python ./scripts/generate_llms.tsxSo the llms.txt is updated accordingly
There was a problem hiding this comment.
Also, #534 mentions adding the production profile, do you think you can add that here as well?
There was a problem hiding this comment.
+1, I think the intent from the issue is to improve the documentation to help parachains achieve the maximum performance. It would make sense to add information regarding the production profile. I would leave it to you to decide where you think it would be most suited to add this.
|
Disclaimer: Moving this to another branch to take over and close the PR |
nhussein11
changed the base branch from
master
to
nhussein11/fix-update-build-profiels
nhussein11
merged commit 4e5f1f7
into
nhussein11/fix-update-build-profiels
2 of 3 checks passed
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.
attempt to fix #534
Since this is a most basic tutorial to start a Parachain, most likely no visitor is in a position to immediately learn about the right flags for production ready compilation. Instead I suggest to remove the misleading wording and simply mention that
--releaseyields a binary for improved runtime performance compared to a regular (debug) build.