Skip to content

Add benchmark your pallet #1189

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

Jump to bottom
Merged
merged 17 commits into from
Nov 24, 2025
Merged

Add benchmark your pallet #1189

merged 17 commits into from
Nov 24, 2025

Conversation

@brunopgalvao
Copy link
Contributor

@brunopgalvao brunopgalvao commented Nov 7, 2025

📝 Description

Resolves #1085

🔍 Review Preference

Choose one:

  • ✅ I have time to handle formatting/style feedback myself
  • ⚡ Docs team handles formatting (check "Allow edits from maintainers")

🤖 AI-Ready Docs

If content changed, regenerate AI files:

  • ✅ I ran python3 scripts/generate_llms.py
  • ⚡ Docs team will regenerate (check "Allow edits from maintainers")

✅ Checklist

@brunopgalvao brunopgalvao self-assigned this Nov 7, 2025
@brunopgalvao brunopgalvao added B0 - Needs Review Pull request is ready for review C1 - Medium Medium priority task A0 - New Content Pull request contains new content pages labels Nov 7, 2025
@brunopgalvao brunopgalvao marked this pull request as ready for review November 8, 2025 04:17
@brunopgalvao brunopgalvao requested a review from a team as a code owner November 8, 2025 04:17
nhussein11
nhussein11 approved these changes Nov 11, 2025
View reviewed changes
Copy link
Collaborator

@nhussein11 nhussein11 left a comment

Choose a reason for hiding this comment

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

Interesting read, thank you!

Copilot finished reviewing on behalf of dawnkelly09 November 18, 2025 18:49
Copilot AI reviewed Nov 18, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request comprehensively rewrites the pallet benchmarking guide, transforming it from a general framework overview into a hands-on tutorial that builds on the pallet development series. The changes provide step-by-step instructions for benchmarking custom pallets, from creating benchmarking modules to integrating generated weights into production runtimes.

Key changes:

  • Complete rewrite of the benchmark guide with practical, actionable steps for the custom counter pallet example
  • Title updates for consistency: "Pallet Testing" → "Unit Test Pallets" and "Benchmarking FRAME Pallets" → "Benchmark Your Pallet"
  • Addition of detailed explanations for each step, including weight trait definitions, runtime integration, and production deployment

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
benchmark-pallet.md Complete rewrite from conceptual overview to practical tutorial with code examples for benchmarking custom pallets
pallet-testing.md Title updated to "Unit Test Pallets" for better clarity and consistency
create-a-pallet.md Added reference to setup guide for Polkadot Omni Node and Chain Spec Builder
.nav.yml Updated navigation title to match renamed "Unit Test Pallets"
llms.txt, llms-full.jsonl, .ai/* Regenerated AI-ready documentation files with updated content

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

dawnkelly09
dawnkelly09 reviewed Nov 18, 2025
View reviewed changes
Copy link
Collaborator

@dawnkelly09 dawnkelly09 left a comment

Choose a reason for hiding this comment

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

One question for Bruno. This can be checked by Erin.

@brunopgalvao
Copy link
Contributor Author

brunopgalvao commented Nov 19, 2025

One question for Bruno. This can be checked by Erin.

@dawnkelly09 Yep, this is in pallets/pallet-custom/src/weights.rs

eshaben
eshaben reviewed Nov 20, 2025
View reviewed changes
dawnkelly09 and others added 7 commits November 20, 2025 13:51
@dawnkelly09
update snippet title
b027f5a
@dawnkelly09 @eshaben
Apply suggestions from code review
f4577d1 
Co-authored-by: Erin Shaben <eshaben@icloud.com>
@dawnkelly09
apply feedback from review
1177ee7
@nhussein11 @0xlukem @dawnkelly09
Add Hardhat Get Started (new IA) (#1196)
57a8f6e 
* add harthdat get started

* fix: llms

* fix and formating

* fix

---------

Co-authored-by: 0xlukem <lucas.malizia27@gmail.com>
@nhussein11 @eshaben @dawnkelly09
Fix local dev node (#1226)
dcc644b 
* Remove outdated warning reference from local development node documentation

* fix: llms

* fix: llms

---------

Co-authored-by: Erin Shaben <eshaben@icloud.com>
@nhussein11 @dawnkelly09
@github-actions @eshaben
Add Remix IDE (new IA) (#1174)
24bf1c6 
* fix: get started ready

* fix: remix deploy

* Update troubleshooting guide for Remix IDE and comment out 'Verify a Contract' section in navigation

* fix: images and names

* fix: remove verify contract file

* fix: llms

* Apply suggestions from code review

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix: prerequisite

* fix: llms

* Grammarly things and reformat to FAQ style dropdowns for troubleshooting page

* applies review feedback

* Clean up formatting of titles and bullets

* fix: feedback

* fix: llms

* fix: gifs lists wording

* fix: llms

* Remove outdated troubleshooting and verification guides for Remix IDE on Polkadot Hub.

* fix errant merge conflict syntax, description length

* applies review feedback

* grammarly pass

* minor fix and llms

---------

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: DAWN KELLY <dawnkelly09@gmail.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
@eshaben @dawnkelly09
Hide pages for MVP (#1251)
bf0b001 
* hide content for mvp launch

* update llms config to skip chain interactions and reference sections

* llms
@dawnkelly09 dawnkelly09 requested a review from eshaben November 24, 2025 17:56
@eshaben eshaben added B1 - Ready to Merge Pull request is ready to be merged and removed B0 - Needs Review Pull request is ready for review labels Nov 24, 2025
@eshaben eshaben merged commit 95950b0 into staging/product-ia Nov 24, 2025
3 of 4 checks passed
@eshaben eshaben deleted the bruno/benchmarking branch November 24, 2025 20:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dawnkelly09 dawnkelly09 dawnkelly09 left review comments

Copilot code review Copilot Copilot left review comments

@eshaben eshaben eshaben approved these changes

@nhussein11 nhussein11 nhussein11 approved these changes

Assignees

@brunopgalvao brunopgalvao

@dawnkelly09 dawnkelly09

Labels

A0 - New Content Pull request contains new content pages B1 - Ready to Merge Pull request is ready to be merged C1 - Medium Medium priority task

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@brunopgalvao @eshaben @nhussein11 @dawnkelly09