-
Notifications
You must be signed in to change notification settings - Fork 98
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
base: master
Are you sure you want to change the base?
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.
I only found a few minor fixes.
Co-authored-by: Taylor Lucero <[email protected]>
Co-authored-by: Taylor Lucero <[email protected]>
Co-authored-by: Taylor Lucero <[email protected]>
Co-authored-by: Taylor Lucero <[email protected]>
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.
LGTM 🚀
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.
I went through and checked the variables, I believe I found some that are gonna throw an issue.
builders/interoperability/xcm/xc20/send-xc20s/xtokens-precompile.md
Outdated
Show resolved
Hide resolved
@Telucero Thx for flagging, I added back the removed vars. |
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
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
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.
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.
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.
Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.
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.
Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.
Thx for flagging! Fixed all |
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.
I think it looks good!
Description
Simplify / Revise How we show Weights in Docs.
Checklist
moonbeam-docs-cn
repo, I have created a ticket for the translations in Jiramoonbeam-mkdocs
to update redirectsmove-pages.py
script to move the pages and update the image paths on the chinese repomoonbeam-docs-cn
compress-images.py
script to compress the images.moonbeam-docs-cn
repo to use the new variablesCorresponding PRs
Please link to any corresponding PRs here.
After Translation Requirements
moonbeam-docs
repo to remove imagesmoonbeam-docs
repo to remove variablesmoonbeam-mkdocs
repo to add redirects for Chinese siteItems to be Updated
Please list any of the items that will need to be added or deleted after the translations are done here.