-
Notifications
You must be signed in to change notification settings - Fork 49
[Add] - runtime upgrade tutorial #760
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Adds a new tutorial on performing runtime upgrades for Polkadot SDK-based chains, integrates it into the existing zero-to-hero series, and updates navigation and documentation indices.
- Introduces
runtime-upgrade.md
with step-by-step guidance to add areset_counter
dispatchable, bump runtime versions, submit via sudo/governance, and verify the upgrade. - Updates the tutorial navigation (
.pages
) and LLMS index (llms.txt
) to include the new “Runtime Upgrade” entry. - Adds a termynal snippet (
runtime-compilation.html
) to show WASM build artifacts, plus minor line-reference updates in existing tutorials.
Reviewed Changes
Copilot reviewed 8 out of 19 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
tutorials/polkadot-sdk/parachains/zero-to-hero/runtime-upgrade.md | New tutorial on runtime upgrades |
tutorials/polkadot-sdk/parachains/zero-to-hero/.pages | Adds “Runtime Upgrade” to navigation |
tutorials/polkadot-sdk/parachains/zero-to-hero/llms.txt | Registers the new tutorial URL for LLMS |
.snippets/code/.../runtime-upgrade/runtime-compilation.html | Adds terminal snippet for WASM build output |
tutorials/polkadot-sdk/parachains/zero-to-hero/pallet-unit-testing.md | Updates code reference line numbers |
tutorials/polkadot-sdk/parachains/zero-to-hero/pallet-benchmarking.md | Pins frame-omni-bencher to v0.10.0 and updates hl_lines |
tutorials/polkadot-sdk/parachains/zero-to-hero/build-custom-pallet.md | Updates code reference line numbers |
tutorials/polkadot-sdk/parachains/zero-to-hero/add-pallets-to-runtime.md | Adjusts code reference hl_lines and minor phrasing |
Comments suppressed due to low confidence (4)
tutorials/polkadot-sdk/parachains/zero-to-hero/runtime-upgrade.md:79
- The comment refers to the “decrement action” but the test is checking an increment. Update it to reflect the increment action (e.g., “Ensure the event matches the increment action”).
// Ensure the event matches the decrement action
tutorials/polkadot-sdk/parachains/zero-to-hero/runtime-upgrade.md:116
- [nitpick] This heading duplicates an earlier section title. Consider renaming it to something more specific (e.g., “Update Runtime Configuration”) to avoid confusion.
### Update the Runtime
tutorials/polkadot-sdk/parachains/zero-to-hero/runtime-upgrade.md:179
- The list numbering jumps from 1 to 3, which may confuse readers. Change “3.” to “2.” to maintain proper sequence.
3. Click on the **Developer** and select the **Extrinsics** option in the dropdown
tutorials/polkadot-sdk/parachains/zero-to-hero/.pages:8
- [nitpick] The navigation list has an extra dash and inconsistent indentation here. Align this entry with the other list items for consistent YAML formatting.
- 'Pallet Benchmarking': pallet-benchmarking.md
tutorials/polkadot-sdk/parachains/zero-to-hero/pallet-unit-testing.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔍 Documentation URL Checker This PR modifies documentation files in ways that could potentially create broken links. Deleted files:
🚨 Please review these changes carefully 🚨 If not handled properly, broken links (404 errors) could appear. To maintain a smooth user experience, consider:
|
🔍 Documentation URL Checker This PR modifies documentation files in ways that could potentially create broken links. Deleted files:
🚨 Please review these changes carefully 🚨 If not handled properly, broken links (404 errors) could appear. To maintain a smooth user experience, consider:
|
|
I checked for anything linking to the now removed Foundry page but didn't find anything I think this is ok. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚀
This PR adds a tutorial for performing runtime upgrades as part of the zero to hero tutorials.
This is a follow up of #756, so please, let's merge that first
This PR is needed to solve #689.