Skip to content

update build flag tip #557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 22, 2025
Merged

update build flag tip #557

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1741d34
Update set-up-a-template.md
PieWol Apr 10, 2025
d9565fd
update compiler flag tip
PieWol Apr 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tutorials/polkadot-sdk/parachains/zero-to-hero/set-up-a-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.tsx

So the llms.txt is updated accordingly

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, #534 mentions adding the production profile, do you think you can add that here as well?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+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.


4. Upon successful compilation, you should see output similar to:
--8<-- 'code/tutorials/polkadot-sdk/parachains/zero-to-hero/set-up-a-template/compilation-output.html'
Expand Down
Loading