Skip to content

Commit f0056eb

Browse files
0xlukemeshaben
andauthored
Modify the titles to be more action-oriented (#398)
* modify the titles to be more action oriented * update the llms.txt * add more action oriented titles * update llms.txt * Apply suggestions from code review Co-authored-by: Erin Shaben <[email protected]> * update llms.txt --------- Co-authored-by: Erin Shaben <[email protected]>
1 parent 6bd608a commit f0056eb

File tree

8 files changed

+50
-50
lines changed

8 files changed

+50
-50
lines changed

llms.txt

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -18081,7 +18081,7 @@ Before proceeding, ensure you meet the following requirements:
1808118081
- Blockchain network with a relay chain and at least two connected parachains
1808218082
- Wallet with sufficient funds to execute transactions on the participant chains
1808318083

18084-
## Procedure for Initiating HRMP Channel Setup
18084+
## Procedure to Initiate an HRMP Channel
1808518085

1808618086
This example will demonstrate how to open a channel between parachain 2500 and parachain 2600, using Rococo Local as the relay chain.
1808718087

@@ -18129,7 +18129,7 @@ Use [Polkadot.js Apps](https://polkadot.js.org/apps/#/explorer){target=\_blank}
1812918129
![](/images/tutorials/interoperability/xcm-channels/para-to-para/hrmp-para-to-para-2.webp)
1813018130
The encoded call data for opening a channel with parachain 2600 is `0x3c00280a00000800000000001000`.
1813118131

18132-
### Crafting and Submitting the XCM Message from the Sender
18132+
### Craft and Submit the XCM Message from the Sender
1813318133

1813418134
To initiate the HRMP channel opening process, you need to create an XCM message that includes the encoded `hrmpInitOpenChannel` call data from the previous step. This message will be sent from your parachain to the relay chain.
1813518135

@@ -18175,7 +18175,7 @@ After submitting the XCM message to initiate the HRMP channel opening, you shoul
1817518175

1817618176
If your channel request was successful, you should see an entry for your parachain ID in the list of open channel requests. This confirms that your request has been properly registered on the relay chain and is awaiting acceptance by the target parachain.
1817718177

18178-
## Procedure for Accepting HRMP Channel
18178+
## Procedure to Accept an HRMP Channel
1817918179

1818018180
For the channel to be fully established, the target parachain must accept the channel request by submitting an XCM message to the relay chain.
1818118181

@@ -18200,9 +18200,9 @@ To fund the account, follow the same process described in the previous section,
1820018200
![](/images/tutorials/interoperability/xcm-channels/para-to-para/hrmp-para-to-para-5.webp)
1820118201
The encoded call data for accepting a channel with parachain 2500 should be `0x3c01c4090000`
1820218202

18203-
### Crafting and Submitting the XCM Message from the Receiver
18203+
### Craft and Submit the XCM Message from the Receiver
1820418204

18205-
To accept the HRMP channel opening, you need to create and submit an XCM message that includes the encoded `hrmpAcceptOpenChannel` call data from the previous step. This process is similar to the one described in the previous section, [Crafting and Submitting the XCM Message](#crafting-and-submitting-the-xcm-message-from-the-sender), with a few key differences:
18205+
To accept the HRMP channel opening, you need to create and submit an XCM message that includes the encoded `hrmpAcceptOpenChannel` call data from the previous step. This process is similar to the one described in the previous section, [Craft and Submit the XCM Message](#craft-and-submit-the-xcm-message-from-the-sender), with a few key differences:
1820618206

1820718207
- Use the encoded call data for `hrmpAcceptOpenChannel` obtained in Step 2 of this section
1820818208
- In the last XCM instruction (DepositAsset), set the beneficiary to parachain 2600's sovereign account to receive any surplus funds
@@ -18264,7 +18264,7 @@ To successfully complete this process, you'll need to have the following in plac
1826418264
- An Asset Hub system chain
1826518265
- A wallet containing enough funds to cover transaction fees on each of the participating chains
1826618266

18267-
## Procedure for Establishing HRMP Channel
18267+
## Procedure to Establish an HRMP Channel
1826818268

1826918269
This guide demonstrates opening an HRMP channel between parachain 2500 and system chain Asset Hub (parachain 1000) on the Rococo Local relay chain.
1827018270

@@ -18311,7 +18311,7 @@ Use [Polkadot.js Apps](https://polkadot.js.org/apps/#/explorer){target=\_blank}
1831118311
![](/images/tutorials/interoperability/xcm-channels/para-to-system/hrmp-para-to-system-1.webp)
1831218312
The encoded call data for establishing a channel with system parachain 1000 should be `0x3c0ae8030000`
1831318313

18314-
### Crafting and Submitting the XCM Message
18314+
### Craft and Submit the XCM Message
1831518315

1831618316
Connect to parachain 2500 using Polkadot.js Apps to send the XCM message to the relay chain. Input the necessary parameters as illustrated in the image below. Make sure to:
1831718317

@@ -18424,7 +18424,7 @@ After executing this command, the relay chain and parachain will expose the foll
1842418424

1842518425
You can perform the reserve-backed transfer using either the [Polkadot.js Apps interface](#using-polkadotjs-apps) or the [Polkadot API](#using-papi), depending on your preference. Both methods provide the same functionality to facilitate asset transfers between the relay chain and parachain.
1842618426

18427-
## Using Polkadot.js Apps
18427+
## Use Polkadot.js Apps
1842818428

1842918429
Open two browser tabs and can connect these endpoints using the [Polkadot.js Apps](https://polkadot.js.org/apps/){target=\_blank} interface:
1843018430

@@ -18485,7 +18485,7 @@ After submitting the transaction from the relay chain, confirm its success by ch
1848518485

1848618486
![](/images/tutorials/interoperability/xcm-transfers/from-relaychain-to-parachain/from-relaychain-to-parachain-07.webp)
1848718487

18488-
## Using PAPI
18488+
## Use PAPI
1848918489

1849018490
To programmatically execute the reserve-backed asset transfer between the relay chain and the parachain, you can use [Polkadot API (PAPI)](/develop/toolkit/api-libraries/papi/){target=\_blank}. PAPI is a robust toolkit that simplifies interactions with Polkadot-based chains. For this project, you'll first need to set up your environment, install necessary dependencies, and create a script to handle the transfer process.
1849118491

@@ -18712,7 +18712,7 @@ Before proceeding, ensure the following prerequisites are met:
1871218712
- [Polkadot.js](/develop/toolkit/api-libraries/polkadot-js-api){target=\_blank}
1871318713
- [OpenGov](/polkadot-protocol/onchain-governance/overview){target=\_blank}
1871418714

18715-
## Setting Up the Project
18715+
## Set Up the Project
1871618716

1871718717
Before testing OpenGov proposals, you need to set up your development environment.
1871818718
You'll set up a TypeScript project and install the required dependencies to simulate and evaluate proposals. You'll use Chopsticks to fork the Polkadot network and simulate the proposal lifecycle, while Polkadot.js will be your interface for interacting with the forked network and submitting proposals.
@@ -18761,7 +18761,7 @@ Follow these steps to set up your project:
1876118761
}
1876218762
```
1876318763

18764-
## Submitting and Executing a Proposal Using Chopsticks
18764+
## Submit and Execute a Proposal Using Chopsticks
1876518765

1876618766
You should identify the right track and origin for your proposal. For example, select the appropriate treasury track based on the spending limits if you're requesting funds from the treasury. For more detailed information, refer to [Polkadot OpenGov Origins](https://wiki.polkadot.network/docs/learn-polkadot-opengov-origins){target=\_blank}.
1876718767

@@ -21195,7 +21195,7 @@ try {
2119521195
// --8<-- [end:try-catch-block]
2119621196
```
2119721197

21198-
## Executing the Proposal Script
21198+
## Execute the Proposal Script
2119921199

2120021200
To run the proposal execution script, use the following command in your terminal:
2120121201

@@ -24822,7 +24822,7 @@ Before proceeding, you should have the following items:
2482224822

2482324823
Once the above is complete, obtaining coretime is the last step to enable your parachain to start producing and finalizing blocks using the relay chain's validator set. If you don't, refer to the previous tutorial: [Deploy on Paseo TestNet](/tutorials/polkadot-sdk/parachains/zero-to-hero/deploy-to-testnet/){target=\_blank}.
2482424824

24825-
## Purchasing Bulk Coretime
24825+
## Purchase Bulk Coretime
2482624826

2482724827
Purchasing bulk coretime involves purchasing a core from the [Coretime Chain](/polkadot-protocol/architecture/system-chains/coretime/){target=\_blank}, which has an instance of [`pallet_broker`](https://paritytech.github.io/polkadot-sdk/master/pallet_broker/index.html){target=\_blank} (the Broker pallet). Although this can be done via sending extrinsics through a tool like Polkadot.js Apps, there are user interfaces for purchasing and managing bulk coretime:
2482824828

@@ -24832,7 +24832,7 @@ Purchasing bulk coretime involves purchasing a core from the [Coretime Chain](/p
2483224832
!!!tip
2483324833
Obtaining a core for bulk coretime on Paseo follows a different process from Polkadot or Kusama. To apply for a core on Paseo, visit their guide for doing so: [PAS-10 Onboard Paras Coretime](https://github.com/paseo-network/paseo-action-submission/blob/main/pas/PAS-10-Onboard-paras-coretime.md#summary){target=\_blank}.
2483424834

24835-
### Getting Coretime Funds
24835+
### Get Coretime Funds
2483624836

2483724837
First, ensure your wallet is connected to the [RegionX](https://app.regionx.tech){target=\_blank} interface. To do so, go to **Home** in the RegionX app and click the **Connect Wallet** button in the upper right.
2483824838

@@ -24846,7 +24846,7 @@ If successful, you should see the balance in the upper right of the **Transfer**
2484624846

2484724847
![](/images/tutorials/polkadot-sdk/parachains/zero-to-hero/obtain-coretime/obtain-coretime-2.webp)
2484824848

24849-
### Purchasing a Core
24849+
### Purchase a Core
2485024850

2485124851
For this tutorial, we will use [RegionX](https://app.regionx.tech){target=\_blank}. Once you open the app, you should be presented with the following screen:
2485224852

@@ -24868,7 +24868,7 @@ Once the transaction is confirmed, click [**My Regions**](https://app.regionx.te
2486824868

2486924869
Congratulations, you just purchased a core using RegionX! You can assign the core to your parachain, partition, interlace, and more using RegionX.
2487024870

24871-
### Assigning a Core
24871+
### Assign a Core
2487224872

2487324873
Once you have the core as shown in the dashboard, select it by clicking on it, then click the **Assign** option on the left-hand side. You will be presented with a modal in which you can add a new task.
2487424874

@@ -24882,7 +24882,7 @@ You may now select a task from the list. You must also set the core's finality,
2488224882

2488324883
Once you sign and send this transaction, that task/parachain will be assigned to that core.
2488424884

24885-
## Ordering On Demand Coretime
24885+
## Order On Demand Coretime
2488624886

2488724887
On Polkadot.js Apps, make sure you're connected to the relay chain, then navigate to [**Developer > Extrinsics**](https://polkadot.js.org/apps/#/extrinsics){target=\_blank} and issue the `onDemand.placeOrderAllowDeath` extrinsic from the account that registered the `ParaID` by specifying sufficient `maxAmount` for the transaction to go through successfully.
2488824888

@@ -25790,7 +25790,7 @@ fn increment_handles_overflow() {
2579025790
}
2579125791
```
2579225792

25793-
### Verifying State Changes
25793+
### Verify State Changes
2579425794

2579525795
Test that pallet operations modify the internal state correctly and maintain expected storage values across different interactions.
2579625796

@@ -26003,7 +26003,7 @@ fn user_interactions_overflow() {
2600326003
}
2600426004
```
2600526005

26006-
## Running Tests
26006+
## Run the Tests
2600726007

2600826008
Execute the test suite for your custom pallet using Cargo's test command. This will run all defined test cases and provide detailed output about the test results.
2600926009

@@ -26283,7 +26283,7 @@ Before converting assets on Asset Hub, you must ensure you have:
2628326283
- A funded wallet containing the assets you wish to convert and enough available funds to cover the transaction fees
2628426284
- An asset registered on Asset Hub that you want to convert. If you haven't created an asset on Asset Hub yet, refer to the [Register a Local Asset](/tutorials/polkadot-sdk/system-chains/asset-hub/register-local-asset/){target=\_blank} or [Register a Foreign Asset](/tutorials/polkadot-sdk/system-chains/asset-hub/register-foreign-asset/){target=\_blank} documentation to create an asset.
2628526285

26286-
## Creating a Liquidity Pool
26286+
## Create a Liquidity Pool
2628726287

2628826288
If an asset on Asset Hub does not have an existing liquidity pool, the first step is to create one.
2628926289

@@ -26352,7 +26352,7 @@ Signing and submitting the transaction triggers the creation of the liquidity po
2635226352

2635326353
As the preceding image shows, the **`lpToken`** ID created for this pool is 19. This ID is essential to identify the liquidity pool and associated LP tokens.
2635426354

26355-
## Adding Liquidity to a Pool
26355+
## Add Liquidity to a Pool
2635626356

2635726357
The `addLiquidity` extrinsic allows users to provide liquidity to a pool of two assets. Users specify their preferred amounts for both assets and minimum acceptable quantities. The function determines the best asset contribution, which may vary from the amounts desired but won't fall below the specified minimums. Providers receive liquidity tokens representing their pool portion in return for their contribution.
2635826358

@@ -26409,9 +26409,9 @@ Signing and submitting the transaction adds liquidity to the pool. To verify the
2640926409

2641026410
![Liquidity Added Event](/images/tutorials/polkadot-sdk/system-chains/asset-hub/asset-conversion/asset-conversion-7.webp)
2641126411

26412-
## Swapping Assets
26412+
## Swap Assets
2641326413

26414-
### Swapping From an Exact Amount of Tokens
26414+
### Swap from an Exact Amount of Tokens
2641526415

2641626416
The asset conversion pallet enables users to exchange a specific quantity of one asset for another in a designated liquidity pool by swapping them for an exact amount of tokens. It guarantees the user will receive at least a predetermined minimum amount of the second asset. This function increases trading predictability and allows users to conduct asset exchanges with confidence that they are assured a minimum return.
2641726417

@@ -26469,7 +26469,7 @@ Signing and submitting the transaction will execute the swap. To verify executio
2646926469

2647026470
![Swap From Exact Tokens Event](/images/tutorials/polkadot-sdk/system-chains/asset-hub/asset-conversion/asset-conversion-10.webp)
2647126471

26472-
### Swapping To an Exact Amount of Tokens
26472+
### Swap to an Exact Amount of Tokens
2647326473

2647426474
Conversely, the Asset Conversion pallet comes with a function that allows users to trade a variable amount of one asset to acquire a precise quantity of another. It ensures that users stay within a set maximum of the initial asset to obtain the desired amount of the second asset. This provides a method to control transaction costs while achieving the intended result.
2647526475

@@ -26526,7 +26526,7 @@ Signing and submitting the transaction will execute the swap. To verify executio
2652626526

2652726527
![Swap Tokens For Exact Tokens Event](/images/tutorials/polkadot-sdk/system-chains/asset-hub/asset-conversion/asset-conversion-13.webp)
2652826528

26529-
## Withdrawing Liquidity from a Pool
26529+
## Withdraw Liquidity from a Pool
2653026530

2653126531
The Asset Conversion pallet provides the `removeLiquidity` extrinsic to remove liquidity from a pool. This function allows users to withdraw the liquidity they offered from a pool, returning the original assets. When calling this function, users specify the number of liquidity tokens (representing their share in the pool) they wish to burn. They also set minimum acceptable amounts for the assets they expect to receive back. This mechanism ensures that users can control the minimum value they receive, protecting against unfavorable price movements during the withdrawal process.
2653226532

tutorials/interoperability/xcm-channels/para-to-para.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Before proceeding, ensure you meet the following requirements:
2525
- Blockchain network with a relay chain and at least two connected parachains
2626
- Wallet with sufficient funds to execute transactions on the participant chains
2727

28-
## Procedure for Initiating HRMP Channel Setup
28+
## Procedure to Initiate an HRMP Channel
2929

3030
This example will demonstrate how to open a channel between parachain 2500 and parachain 2600, using Rococo Local as the relay chain.
3131

@@ -73,7 +73,7 @@ Use [Polkadot.js Apps](https://polkadot.js.org/apps/#/explorer){target=\_blank}
7373
![](/images/tutorials/interoperability/xcm-channels/para-to-para/hrmp-para-to-para-2.webp)
7474
The encoded call data for opening a channel with parachain 2600 is `0x3c00280a00000800000000001000`.
7575

76-
### Crafting and Submitting the XCM Message from the Sender
76+
### Craft and Submit the XCM Message from the Sender
7777

7878
To initiate the HRMP channel opening process, you need to create an XCM message that includes the encoded `hrmpInitOpenChannel` call data from the previous step. This message will be sent from your parachain to the relay chain.
7979

@@ -119,7 +119,7 @@ After submitting the XCM message to initiate the HRMP channel opening, you shoul
119119

120120
If your channel request was successful, you should see an entry for your parachain ID in the list of open channel requests. This confirms that your request has been properly registered on the relay chain and is awaiting acceptance by the target parachain.
121121

122-
## Procedure for Accepting HRMP Channel
122+
## Procedure to Accept an HRMP Channel
123123

124124
For the channel to be fully established, the target parachain must accept the channel request by submitting an XCM message to the relay chain.
125125

@@ -144,9 +144,9 @@ To fund the account, follow the same process described in the previous section,
144144
![](/images/tutorials/interoperability/xcm-channels/para-to-para/hrmp-para-to-para-5.webp)
145145
The encoded call data for accepting a channel with parachain 2500 should be `0x3c01c4090000`
146146

147-
### Crafting and Submitting the XCM Message from the Receiver
147+
### Craft and Submit the XCM Message from the Receiver
148148

149-
To accept the HRMP channel opening, you need to create and submit an XCM message that includes the encoded `hrmpAcceptOpenChannel` call data from the previous step. This process is similar to the one described in the previous section, [Crafting and Submitting the XCM Message](#crafting-and-submitting-the-xcm-message-from-the-sender), with a few key differences:
149+
To accept the HRMP channel opening, you need to create and submit an XCM message that includes the encoded `hrmpAcceptOpenChannel` call data from the previous step. This process is similar to the one described in the previous section, [Craft and Submit the XCM Message](#craft-and-submit-the-xcm-message-from-the-sender), with a few key differences:
150150

151151
- Use the encoded call data for `hrmpAcceptOpenChannel` obtained in Step 2 of this section
152152
- In the last XCM instruction (DepositAsset), set the beneficiary to parachain 2600's sovereign account to receive any surplus funds

tutorials/interoperability/xcm-channels/para-to-system.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ To successfully complete this process, you'll need to have the following in plac
2323
- An Asset Hub system chain
2424
- A wallet containing enough funds to cover transaction fees on each of the participating chains
2525

26-
## Procedure for Establishing HRMP Channel
26+
## Procedure to Establish an HRMP Channel
2727

2828
This guide demonstrates opening an HRMP channel between parachain 2500 and system chain Asset Hub (parachain 1000) on the Rococo Local relay chain.
2929

@@ -70,7 +70,7 @@ Use [Polkadot.js Apps](https://polkadot.js.org/apps/#/explorer){target=\_blank}
7070
![](/images/tutorials/interoperability/xcm-channels/para-to-system/hrmp-para-to-system-1.webp)
7171
The encoded call data for establishing a channel with system parachain 1000 should be `0x3c0ae8030000`
7272

73-
### Crafting and Submitting the XCM Message
73+
### Craft and Submit the XCM Message
7474

7575
Connect to parachain 2500 using Polkadot.js Apps to send the XCM message to the relay chain. Input the necessary parameters as illustrated in the image below. Make sure to:
7676

tutorials/interoperability/xcm-transfers/from-relaychain-to-parachain.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ After executing this command, the relay chain and parachain will expose the foll
3636

3737
You can perform the reserve-backed transfer using either the [Polkadot.js Apps interface](#using-polkadotjs-apps) or the [Polkadot API](#using-papi), depending on your preference. Both methods provide the same functionality to facilitate asset transfers between the relay chain and parachain.
3838

39-
## Using Polkadot.js Apps
39+
## Use Polkadot.js Apps
4040

4141
Open two browser tabs and can connect these endpoints using the [Polkadot.js Apps](https://polkadot.js.org/apps/){target=\_blank} interface:
4242

@@ -97,7 +97,7 @@ After submitting the transaction from the relay chain, confirm its success by ch
9797
9898
![](/images/tutorials/interoperability/xcm-transfers/from-relaychain-to-parachain/from-relaychain-to-parachain-07.webp)
9999
100-
## Using PAPI
100+
## Use PAPI
101101
102102
To programmatically execute the reserve-backed asset transfer between the relay chain and the parachain, you can use [Polkadot API (PAPI)](/develop/toolkit/api-libraries/papi/){target=\_blank}. PAPI is a robust toolkit that simplifies interactions with Polkadot-based chains. For this project, you'll first need to set up your environment, install necessary dependencies, and create a script to handle the transfer process.
103103

0 commit comments

Comments
 (0)