-
Notifications
You must be signed in to change notification settings - Fork 74
Refactor and improve Technical Reference > Parachain > Consensus > Assets & Smart Contracts #1129
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: staging/product-ia
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.
Pull Request Overview
This PR splits the existing "Assets and Smart Contracts" page into two dedicated pages—Assets and Smart Contracts—in the Technical Reference section. The refactoring improves content organization by separating asset management concepts from smart contract deployment options on Asset Hub.
Key changes:
- Creates dedicated
assets.mdpage covering Asset Hub's asset management features, pallets, and XCM integration - Introduces
smart-contracts.mdpage explaining PolkaVM and REVM contract deployment options - Updates navigation files to reflect the new structure
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| reference/polkadot-hub/smart-contracts.md | New page documenting smart contract options (PolkaVM and REVM) on Asset Hub |
| reference/polkadot-hub/assets.md | New page covering asset management, pallets, foreign assets, and XCM monitoring |
| reference/polkadot-hub/assets-and-smart-contracts.md | Removed original combined page |
| reference/polkadot-hub/.nav.yml | Updated navigation to link to separate assets and smart-contracts pages |
| .nav.yml | Added Technical Reference section to main navigation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
nhussein11
left a comment
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.
Thank you @kapetan3sid ! Left some comments, maybe after the refactoring of the assets page, the combination assets.md + smart-contracts.md is not that lenghty and it could fit everything under the same page
|
@kapetan3sid let me know when it's ready. Seems like there are some major changes that need to be made and approved by Nico before I step in. |
Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com>
Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com>
|
@nhussein11 I applied changes - this is ready for re-review |
nhussein11
left a comment
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.
Thank you very much @kapetan3sid !
Left some comments, but I believe those can be taken over by the @polkadot-developers/docs-formatting-team. Just a quick note, the ai files were not pushed and there are some instances of target={_blank} that I did not flag
Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com>
Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com>
Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com>
Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com>
Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com>
|
@erin ready for your review |
Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com>
|
Assets Page: I removed a lot of the technical references from this page, because they were used for like querying the data, but not most of the core extrinsics. Since this page is conceptual, I didn't think we need to callout the exact function signature and details. So I removed that. I also removed the part about monitoring XCM transfers because it just felt out of place. I think this content should be in the XCM guides instead if needed. Contracts Page: Overall, this page doesn't seem to have a clear purpose. It mentioned PolkaVM so I commented that out. Then what was left was very little and is duplicated elsewhere in the docs. Maybe someone can tell me what the purpose of this page is? Especially versus this page: https://beta-docs.polkadot.com/smart-contracts/for-eth-devs/contract-deployment/#revm-deployment |
I agree. Also the Assets page should be less of a reference to the assets pallet API and more of how assets work on the Polkadot Hub. We need to be telling the story of what Polkadot Hub is, in terms of asset creation and management, smart contract functionality, etc. |
Co-authored-by: Bruno Galvao <brunopgalvao@gmail.com>
Co-authored-by: Bruno Galvao <brunopgalvao@gmail.com>
Co-authored-by: Bruno Galvao <brunopgalvao@gmail.com>
Co-authored-by: Bruno Galvao <brunopgalvao@gmail.com>
Co-authored-by: Bruno Galvao <brunopgalvao@gmail.com>
Co-authored-by: Bruno Galvao <brunopgalvao@gmail.com>
Co-authored-by: Bruno Galvao <brunopgalvao@gmail.com>
Yeah, I agree. So it sounds like this page will need DevRel attention then. So I propose we ship it with what's there and then a ticket be created for the backlog so that you or Nico can circle back to it. |
Sounds good to me. |
|
@brunopgalvao ok, I made sure your comments were addressed so this should be good to go for now. Then, whenever time permits, either you or Nico can circle back to it and make sure the content aligns with the goals of the page. |
dawnkelly09
left a comment
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 introduces two new pages in the Technical Reference section: