Skip to content

Simplify / Revise How we show Weights in Docs #1166

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

Open
wants to merge 20 commits into
base: master
Choose a base branch
from

Conversation

themacexpert
Copy link
Contributor

Description

Simplify / Revise How we show Weights in Docs.

  • Link to relevant polkadot SDK links rather than putting the exact numbers in tables.
  • Show general calculation instructions rather than specific examples, e.g. show A = B+C rather than 14 = 10 + 4

Checklist

  • I have added a label to this PR 🏷️
  • I have run my changes through Grammarly
  • If this requires translations for the moonbeam-docs-cn repo, I have created a ticket for the translations in Jira
  • If pages have been moved around, I have created an additional PR in moonbeam-mkdocs to update redirects
  • If pages have been moved around, I have run the move-pages.py script to move the pages and update the image paths on the chinese repo
    • After the script has been run, I have created an additional PR in moonbeam-docs-cn
  • If images have been added, I have run the compress-images.py script to compress the images.
  • If variables (in variables.yml) need to be updated (such as a name change), I have updated the moonbeam-docs-cn repo to use the new variables
  • If this page requires a disclaimer, I have added one

Corresponding PRs

Please link to any corresponding PRs here.

After Translation Requirements

  • Will need to create PR in moonbeam-docs repo to remove images
  • Will need to create PR in moonbeam-docs repo to remove variables
  • Will need to create PR in moonbeam-mkdocs repo to add redirects for Chinese site
  • No additional PRs are required after the translations are done

Items to be Updated

Please list any of the items that will need to be added or deleted after the translations are done here.

@Copilot Copilot AI review requested due to automatic review settings July 2, 2025 15:22
@themacexpert themacexpert requested a review from a team as a code owner July 2, 2025 15:22
@themacexpert themacexpert requested review from ibbar and removed request for Copilot July 2, 2025 15:22
@themacexpert themacexpert added A2 - Maintenance Minor Pull request contains minor updates to an existing page (i.e., modifying parameters, steps, etc.) B0 - Needs Review Pull request is ready for review labels Jul 2, 2025
Copilot

This comment was marked as outdated.

Copy link
Contributor

@Telucero Telucero left a comment

Choose a reason for hiding this comment

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

I only found a few minor fixes.

0xlukem
0xlukem previously approved these changes Jul 7, 2025
Copy link
Contributor

@0xlukem 0xlukem left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

Telucero
Telucero previously approved these changes Jul 7, 2025
@Telucero Telucero added B1 - Ready to Merge Pull request is ready to be merged and removed B1 - Ready to Merge Pull request is ready to be merged labels Jul 7, 2025
@eshaben eshaben requested a review from Telucero July 8, 2025 14:30
Copy link
Contributor

@Telucero Telucero left a comment

Choose a reason for hiding this comment

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

I went through and checked the variables, I believe I found some that are gonna throw an issue.

@themacexpert
Copy link
Contributor Author

@Telucero Thx for flagging, I added back the removed vars.

@themacexpert themacexpert requested a review from Copilot July 8, 2025 20:18
Copy link

@Copilot 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

Simplify how weight values are presented in documentation by linking to SDK sources, replacing explicit numeric tables with general formulas, and updating network versions.

  • Updated network spec versions and SDK version in variables.yml.
  • Removed detailed weight tables and specific numeric examples, replacing them with repository links and generic calculation steps.
  • Revised wording across docs for clarity and consistency.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
variables.yml Bumped Polkadot/Kusama spec_version and updated polkadot_sdk variable.
llms-full.txt Removed explicit weight tables/numeric examples; added generic formulas with links.
builders/interoperability/xcm/xc20/send-xc20s/xtokens-precompile.md Removed example XCM instruction weight table.
builders/interoperability/xcm/core-concepts/weights-fees.md Removed detailed tables and numeric calculations; replaced with links and instructions.
Comments suppressed due to low confidence (1)

variables.yml:1320

  • The polkadot_sdk entry was un-dented (removed a leading '-'), which may change its YAML structure. Ensure it remains properly nested under the intended parent key.
polkadot_sdk: polkadot-v1.17.1

Copy link
Contributor

@Telucero Telucero left a comment

Choose a reason for hiding this comment

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

Sorry Kevin,
I keep having you come back and fix new things but I tested the links and some brought me to 404 pages.
They were outside diff so I attached line numbers instead.

@themacexpert themacexpert requested a review from Copilot July 9, 2025 22:45
Copy link

@Copilot 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.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@themacexpert themacexpert requested a review from Copilot July 9, 2025 22:49
Copy link

@Copilot 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.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@themacexpert themacexpert requested a review from Telucero July 9, 2025 22:54
@themacexpert
Copy link
Contributor Author

Sorry Kevin, I keep having you come back and fix new things but I tested the links and some brought me to 404 pages. They were outside diff so I attached line numbers instead.

Thx for flagging! Fixed all

Copy link
Contributor

@Telucero Telucero left a comment

Choose a reason for hiding this comment

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

I think it looks good!

@themacexpert themacexpert added B1 - Ready to Merge Pull request is ready to be merged and removed B0 - Needs Review Pull request is ready for review labels Jul 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A2 - Maintenance Minor Pull request contains minor updates to an existing page (i.e., modifying parameters, steps, etc.) B1 - Ready to Merge Pull request is ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants