[FIX] - remote snippets #231

nhussein11 · 2024-12-04T17:31:20Z

This PR aims to:

Fix those links to snippets that weren't updated according to the new IA (mainly asset transfer api page)
Remove those snippets that can be replaced by a remote source tied to a specific version or tag

Note: I double checked before pushing, but please review this PR carefully since I made many changes that are prone to error

0xLucca

LGTM! Just review the PolkadotSDK version in variables.yml

variables.yml

eshaben

Nice! Just thinking maybe we should be enforcing the use of variables more frequently?

develop/toolkit/interoperability/asset-transfer-api/reference.md

.snippets/code/develop/toolkit/interoperability/asset-transfer-api/reference/tx-result.md

develop/toolkit/interoperability/asset-transfer-api/reference.md

nhussein11 · 2024-12-13T20:01:58Z

Removing High and Pre-Launch labels, this PR is a nice to have

…-api/reference/tx-result.md Co-authored-by: Erin Shaben <eshaben@icloud.com>

* fix: add wip * fix: adding last sections * fix: wording * fix: structure * Apply suggestions from code review Co-authored-by: 0xLucca <95830307+0xLucca@users.noreply.github.com> * fix: adding links * fix: images structure * fix: paraphrasing * fix: paraphrasing * Update tutorials/interoperability/xcm-transfers/from-relaychain-to-parachain.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * Update tutorials/interoperability/xcm-transfers/from-relaychain-to-parachain.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * fix: table * fix: adding papi tutorial * fix: paraphrasing * fix: moving code to snippet * fix: snippet * Update tutorials/interoperability/xcm-transfers/from-relaychain-to-parachain.md Co-authored-by: 0xLucca <95830307+0xLucca@users.noreply.github.com> * Update tutorials/interoperability/xcm-transfers/from-relaychain-to-parachain.md Co-authored-by: 0xLucca <95830307+0xLucca@users.noreply.github.com> * Update tutorials/interoperability/xcm-transfers/from-relaychain-to-parachain.md Co-authored-by: 0xLucca <95830307+0xLucca@users.noreply.github.com> * fix: feedback * fix: snippet * fix: link --------- Co-authored-by: 0xLucca <95830307+0xLucca@users.noreply.github.com> Co-authored-by: Erin Shaben <eshaben@icloud.com>

* fix: adding reference to tutorials on asset hub page * Add xcm channels * Add runtime upgrades * Add chain spec * Add custom parachains * fix: adding chopsticks * fix: zombienet * Update develop/parachains/get-started/build-custom-parachains.md Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> * fix: xcm channels references * fix: generate chain specs references * fix: generate chain specs 'where to go next' * fix: build custom parachains references * fix: runtime upgrades references * fix: chopsticks get started references * fix: zombienet get started references * fix: asset hub references * fix: add existing pallets references * fix: add smart contract funcionality references * fix: make custom pallet references * fix: pallet testing references * fix: generate chain specs references * fix: adding comment in build custom parachains * fix: deploy parachain to polkadot references * fix: setup references * fix: consensus get started references removed * fix: architecture parachains references --------- Co-authored-by: 0xLucca <0xlucca.dev@gmail.com> Co-authored-by: 0xLucca <95830307+0xLucca@users.noreply.github.com>

…he Pallet (#232) * wip: build-pallet * Page ready * Improvements * Extract code snippets * Description and grammarly * fix: typo * Add suggestions * Update tutorials/polkadot-sdk/parachains/build-custom-pallet/build-pallet.md Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> * Add root origin reference * Apply suggestions from code review Co-authored-by: Erin Shaben <eshaben@icloud.com> * Apply fmt * Apply suggestions from code review Co-authored-by: Erin Shaben <eshaben@icloud.com> * Apply suggestions from code review Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> * Apply fixes --------- Co-authored-by: nhussein11 <nicolashussein14@gmail.com> Co-authored-by: Nicolás Hussein <80422357+nhussein11@users.noreply.github.com> Co-authored-by: Erin Shaben <eshaben@icloud.com>

* Remove get-started section * Remove build and deploy pages * Apply suggestions from code review Co-authored-by: Erin Shaben <eshaben@icloud.com> --------- Co-authored-by: Erin Shaben <eshaben@icloud.com>

…Unit Testing (#233) * fix: wip * fix: adding snippets * fix: typo * Apply suggestions from code review Co-authored-by: 0xLucca <95830307+0xLucca@users.noreply.github.com> * fix: updating mock runtime\ * fix: snippets comments * fix: typo * fix: closing expandable elements * fix: overflow * fix: overflow * Update tutorials/polkadot-sdk/parachains/build-custom-pallet/pallet-unit-testing.md Co-authored-by: Erin Shaben <eshaben@icloud.com> * fix: feedback * fix: clean up the add tutorial branch * Update tutorials/polkadot-sdk/parachains/build-custom-pallet/pallet-unit-testing.md Co-authored-by: Erin Shaben <eshaben@icloud.com> --------- Co-authored-by: 0xLucca <95830307+0xLucca@users.noreply.github.com> Co-authored-by: Erin Shaben <eshaben@icloud.com>

… issue (#252)

develop/toolkit/interoperability/asset-transfer-api/reference.md

tutorials/polkadot-sdk/system-chains/asset-hub/asset-conversion.md

eshaben

Sorry for the delay in getting back to you on this one! I think some of these links just need to be revisited, not the snippet ones as I saw your comment on those, but just normal links.

Saw some polkadot-js github references, so lets create a variable for that and use the variable in the links pointing to it

Co-authored-by: Erin Shaben <eshaben@icloud.com>

…n.md Co-authored-by: Erin Shaben <eshaben@icloud.com>

nhussein11 · 2025-01-08T11:52:25Z

@eshaben Updated links with variables, this should be good to go now 🚀

eshaben

Sweet! Sorry for the delay. These are the last two things but then it'll be good to go!

develop/parachains/intro-polkadot-sdk.md

develop/smart-contracts/overview.md

eshaben · 2025-01-17T07:50:13Z

@nhussein11 Please request Dawn's review so she give final approval once these are fixed! 🙂

Co-authored-by: Erin Shaben <eshaben@icloud.com>

dawnkelly09

Nits! Sorry!

develop/interoperability/test-and-debug.md

dawnkelly09 · 2025-01-20T20:44:03Z

develop/interoperability/test-and-debug.md


    !!!note
        Developers can take this idea and define as many parachains as they want, like `ParaA`, `ParaB`, `ParaC`, etc

- [**`decl_test_network`**](https://github.com/paritytech/polkadot-sdk/blob/master/polkadot/xcm/xcm-simulator/src/lib.rs#L292){target=\_blank} - defines a testing network consisting of a relay chain and multiple parachains. Takes a network struct as input and implements functionalities for testing, including [`ParachainXcmRouter`](https://paritytech.github.io/polkadot-sdk/master/xcm_simulator_example/struct.ParachainXcmRouter.html){target=\_blank} and [`RelayChainXcmRouter`](https://paritytech.github.io/polkadot-sdk/master/xcm_simulator_example/struct.RelayChainXcmRouter.html){target=\_blank}. The struct must specify the relay chain and an indexed list of parachains to be included in the network:
+- [**`decl_test_network`**](https://github.com/paritytech/polkadot-sdk/blob/{{dependencies.polkadot_sdk.stable_version}}/polkadot/xcm/xcm-simulator/src/lib.rs#L292){target=\_blank} - defines a testing network consisting of a relay chain and multiple parachains. Takes a network struct as input and implements functionalities for testing, including [`ParachainXcmRouter`](https://paritytech.github.io/polkadot-sdk/master/xcm_simulator_example/struct.ParachainXcmRouter.html){target=\_blank} and [`RelayChainXcmRouter`](https://paritytech.github.io/polkadot-sdk/master/xcm_simulator_example/struct.RelayChainXcmRouter.html){target=\_blank}. The struct must specify the relay chain and an indexed list of parachains to be included in the network:


I can't click it here to leave a suggestion but the next paragraphs contain an error:

For guidance on implementing a mock runtime for a Polkadot SDK-based chain, refer to the [Pallet Testing](/develop/parachains/customize-parachain/pallet-testing/){target=\_blank} article. This framework enables thorough testing of runtime and cross-chain interactions.

The link to Pallet Testing is returning 404. Please investigate. Thank you!

fixed in 128682a

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

…ation

dawnkelly09

🚀

nhussein11 added 7 commits December 3, 2024 14:36

fix: asset transfer api missing links

6f70fc4

fix: format snippet

f0afa5a

fix: saset transfer api snippets

329a3bb

fix: typo

5c881ca

fix: vbles

f216419

fix: config trait for utility pallet

1937b83

fix: account snippets

e7873a3

nhussein11 requested a review from a team as a code owner December 4, 2024 17:31

nhussein11 requested a review from 0xLucca December 4, 2024 17:33

0xLucca approved these changes Dec 6, 2024

View reviewed changes

variables.yml Outdated Show resolved Hide resolved

kapetan3sid assigned nhussein11 Dec 10, 2024

kapetan3sid added Pre-Launch C2 - High High priority task labels Dec 10, 2024

eshaben reviewed Dec 11, 2024

View reviewed changes

nhussein11 removed Pre-Launch C2 - High High priority task labels Dec 13, 2024

nhussein11 and others added 2 commits December 16, 2024 10:23

fix: typo

2e766c2

Update .snippets/code/develop/toolkit/interoperability/asset-transfer…

fc1ca3d

…-api/reference/tx-result.md Co-authored-by: Erin Shaben <eshaben@icloud.com>

nhussein11 force-pushed the nhussein11/fix-remote-snippets branch from 31416ce to fc1ca3d Compare December 16, 2024 14:05

nhussein11 and others added 10 commits December 19, 2024 09:57

fix: bounding polkadot-sdk references to polkadot-stable2412

8822633

fix: polkadot js references to v15.0.2

de16373

fix: adding fungible trait example (#226)

fad3a3d

fix: hidding polkaVM instances and adding informational banner (#251)

322ddde

Restructure Get Started section (#246)

65164cc

* Remove get-started section * Remove build and deploy pages * Apply suggestions from code review Co-authored-by: Erin Shaben <eshaben@icloud.com> --------- Co-authored-by: Erin Shaben <eshaben@icloud.com>

changes block-beta mermaid diagrams to flowchart to correct rendering…

e648fa3

… issue (#252)

eshaben reviewed Jan 7, 2025

View reviewed changes

develop/toolkit/interoperability/asset-transfer-api/reference.md Outdated Show resolved Hide resolved

eshaben reviewed Jan 7, 2025

View reviewed changes

tutorials/polkadot-sdk/system-chains/asset-hub/asset-conversion.md Outdated Show resolved Hide resolved

eshaben reviewed Jan 7, 2025

View reviewed changes

nhussein11 and others added 5 commits January 8, 2025 08:33

Update develop/toolkit/interoperability/asset-transfer-api/reference.md

23d2465

Co-authored-by: Erin Shaben <eshaben@icloud.com>

Update develop/toolkit/interoperability/asset-transfer-api/reference.md

026a76b

Co-authored-by: Erin Shaben <eshaben@icloud.com>

Update tutorials/polkadot-sdk/system-chains/asset-hub/asset-conversio…

0369f5a

…n.md Co-authored-by: Erin Shaben <eshaben@icloud.com>

fix: polkadot sdk links attached to variable

6846f35

fix: polkadot js api links atttached to variable now

db2b6e8

nhussein11 requested a review from eshaben January 8, 2025 11:52

nhussein11 added the B0 - Needs Review Pull request is ready for review label Jan 9, 2025

eshaben reviewed Jan 17, 2025

View reviewed changes

develop/parachains/intro-polkadot-sdk.md Outdated Show resolved Hide resolved

develop/smart-contracts/overview.md Outdated Show resolved Hide resolved

Apply suggestions from code review

465eb02

Co-authored-by: Erin Shaben <eshaben@icloud.com>

nhussein11 requested a review from a team as a code owner January 20, 2025 17:04

fix: removing unnecessary image

b04545d

nhussein11 requested a review from dawnkelly09 January 20, 2025 17:06

dawnkelly09 requested changes Jan 20, 2025

View reviewed changes

nhussein11 and others added 2 commits January 20, 2025 18:35

Update develop/interoperability/test-and-debug.md

8ae9eb4

Co-authored-by: Dawn Kelly <83190195+dawnkelly09@users.noreply.github.com>

fix: update link to Pallet Testing article in test-and-debug document…

128682a

…ation

nhussein11 requested a review from dawnkelly09 January 20, 2025 21:37

dawnkelly09 approved these changes Jan 21, 2025

View reviewed changes

eshaben added B1 - Ready to be Merged Pull request is ready to be merged and removed B0 - Needs Review Pull request is ready for review labels Jan 22, 2025

eshaben merged commit 4076003 into master Jan 22, 2025
7 checks passed

eshaben deleted the nhussein11/fix-remote-snippets branch January 22, 2025 06:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FIX] - remote snippets #231

[FIX] - remote snippets #231

nhussein11 commented Dec 4, 2024 •

edited

Loading

0xLucca left a comment

eshaben left a comment •

edited

Loading

nhussein11 commented Dec 13, 2024

eshaben left a comment •

edited

Loading

nhussein11 commented Jan 8, 2025

eshaben left a comment

eshaben commented Jan 17, 2025

dawnkelly09 left a comment

dawnkelly09 Jan 20, 2025

nhussein11 Jan 20, 2025

dawnkelly09 left a comment

[FIX] - remote snippets #231

[FIX] - remote snippets #231

Conversation

nhussein11 commented Dec 4, 2024 • edited Loading

0xLucca left a comment

Choose a reason for hiding this comment

eshaben left a comment • edited Loading

Choose a reason for hiding this comment

nhussein11 commented Dec 13, 2024

eshaben left a comment • edited Loading

Choose a reason for hiding this comment

nhussein11 commented Jan 8, 2025

eshaben left a comment

Choose a reason for hiding this comment

eshaben commented Jan 17, 2025

dawnkelly09 left a comment

Choose a reason for hiding this comment

dawnkelly09 Jan 20, 2025

Choose a reason for hiding this comment

nhussein11 Jan 20, 2025

Choose a reason for hiding this comment

dawnkelly09 left a comment

Choose a reason for hiding this comment

nhussein11 commented Dec 4, 2024 •

edited

Loading

eshaben left a comment •

edited

Loading

eshaben left a comment •

edited

Loading