You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .CONTRIBUTING.md
+25-25Lines changed: 25 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,9 +30,9 @@ You may want to spin up a local version of the documentation site to preview you
30
30
31
31
Building and serving the site requires cloning two repositories:
32
32
33
-
-**[Polkadot MkDocs](https://github.com/papermoonio/polkadot-mkdocs)** - contains the MkDocs configuration files, theme overrides, and custom CSS for the Polkadot documentation site
33
+
-**[Polkadot MkDocs](https://github.com/papermoonio/polkadot-mkdocs)**: Contains the MkDocs configuration files, theme overrides, and custom CSS for the Polkadot documentation site.
34
34
35
-
-**[Polkadot Docs](https://github.com/polkadot-developers/polkadot-docs)** - the actual content is stored in the `polkadot-docs` repository and pulled into the `polkadot-mkdocs` directory during build
35
+
-**[Polkadot Docs](https://github.com/polkadot-developers/polkadot-docs)**: The actual content is stored in the `polkadot-docs` repository and pulled into the `polkadot-mkdocs` directory during build.
36
36
37
37
For everything to work correctly, the file structure needs to be as follows:
38
38
@@ -90,16 +90,16 @@ When adding new pages to the documentation site, it is important to ensure all r
90
90
91
91
To create a new section of pages, you will first need to create a subdirectory with the desired name of the section. The root directory, and every subdirectory, must contain the following files:
92
92
93
-
- `.pages` - defines the structure of the documentation site
94
-
- `index.md` - a landing page which can be used to provide more context about the content in the section
93
+
- **`.pages`**: Defines the structure of the documentation site.
94
+
- **`index.md`**: A landing page which can be used to provide more context about the content in the section.
95
95
96
96
#### Example `.pages` File
97
97
98
98
```markdown
99
99
title: Application Developers
100
100
nav:
101
101
- index.md
102
-
- 'Polkadot SDK': 'polkadot-sdk.md'
102
+
- **'Polkadot SDK'**: 'polkadot-sdk.md'
103
103
- interact
104
104
- tooling
105
105
```
@@ -108,10 +108,10 @@ This example would result in adding 'Application Developers' as a section with t
108
108
109
109
Some important things to note:
110
110
111
-
- The `title` field at the top of the page represents the display name for the section. This is displayed on the left-side navigation bar when viewing the site
112
-
- The `index.md` page should always be the first item in the `nav` list
113
-
- Files follow the convention of `'Display Name': 'file-name.md'`
114
-
- Sections are listed by their directory name in the source code. For example, the Tooling section will be added to the navigation simply by using the directory name: `tooling`
111
+
- The `title` field at the top of the page represents the display name for the section. This is displayed on the left-side navigation bar when viewing the site.
112
+
- The `index.md` page should always be the first item in the `nav` list.
113
+
- Files follow the convention of `'Display Name': 'file-name.md'`.
114
+
- Sections are listed by their directory name in the source code. For example, the Tooling section will be added to the navigation simply by using the directory name: `tooling`.
115
115
116
116
#### Example `index.md` File
117
117
@@ -126,22 +126,22 @@ description: Learn how to build and customize blockchains with Polkadot SDK. Exp
126
126
127
127
Some important things to note:
128
128
129
-
- The `title` represents the `<title>` tag and is used for SEO purposes
130
-
- The `description` represents the meta-description and is also used for SEO purposes
129
+
- The `title` represents the `<title>` tag and is used for SEO purposes.
130
+
- The `description` represents the meta-description and is also used for SEO purposes.
131
131
132
132
### Adding Pages to Existing Section
133
133
134
134
If you are adding pages to an existing section, the steps are simplified. However, it's essential to ensure you complete these steps to display the new page and its title on the documentation site correctly:
135
135
136
136
- Add the new markdown page to the appropriate section. Note that the filename becomes part of the URL for this page. See the [style guide](https://github.com/papermoonio/documentation-style-guide/blob/main/style-guide.md#naming-conventions) for additional guidance on naming conventions.
137
137
- Ensure the new content page includes the following:
138
-
- **`title`** - represents the `<title>` tag and is used for SEO purposes (not displayed on the published site) Titles have a maximum length of 45 characters.
139
-
- **`description`** - represents the meta-description and is also used for SEO purposes (not displayed on the published site). Descriptions should be 120-160 characters and should provide a preview into the page topic.
140
-
- **Page title** - an H1 heading title to be displayed at the top of the page
138
+
- **`title`**: Represents the `<title>` tag and is used for SEO purposes (not displayed on the published site) Titles have a maximum length of 45 characters.
139
+
- **`description`**: Represents the meta-description and is also used for SEO purposes (not displayed on the published site). Descriptions should be 120-160 characters and should provide a preview into the page topic.
140
+
- **Page title**: An H1 heading title to be displayed at the top of the page.
141
141
142
-
- **`## Checking Prerequisites` section** - if the guide requires the user to have specific developer tools installed, for example, Docker or MetaMask, it should be listed here
142
+
- **`## Checking Prerequisites` section**: If the guide requires the user to have specific developer tools installed, for example, Docker or MetaMask, it should be listed here.
143
143
144
-
- Add the 'Display Name': 'file-name.md' for the new page to the `.pages` folder in the same subdirectory where you added the new page
144
+
- **Add the 'Display Name'**: 'file-name.md' for the new page to the `.pages` folder in the same subdirectory where you added the new page.
145
145
146
146
An example new content page might look like:
147
147
@@ -172,10 +172,10 @@ More resources for [SEO Optimization](#search-engine-optimization-seo) of titles
172
172
git checkout -b INSERT_NEW_BRANCH_NAME
173
173
```
174
174
175
-
2. Modify content as desired. Remember to place images and code snippets in the appropriate folders (see the following sections for details)
176
-
3. Review the [style guide](https://github.com/papermoonio/documentation-style-guide/blob/main/style-guide.md) to ensure your new content meets the guidelines
177
-
3. Once you commit and push all of your changes, open a pull request for the new content branch against the `main` branch
178
-
4. Monitor notifications and pull requests for feedback from code owners. At least one approval is required before merging content
175
+
2. Modify content as desired. Remember to place images and code snippets in the appropriate folders (see the following sections for details).
176
+
3. Review the [style guide](https://github.com/papermoonio/documentation-style-guide/blob/main/style-guide.md) to ensure your new content meets the guidelines.
177
+
3. Once you commit and push all of your changes, open a pull request for the new content branch against the `main` branch.
178
+
4. Monitor notifications and pull requests for feedback from code owners. At least one approval is required before merging content.
179
179
180
180
If your additions or modifications are limited to content on an existing page, there is no need to worry about the [`.pages`](#example-pages-file) or [`index.md`](#example-indexmd-file) files, as changes to page content don't affect these files.
181
181
@@ -222,11 +222,11 @@ In general, titles should be between 50 and 60 characters and descriptions shoul
222
222
223
223
There are a few tools you may find useful for proofreading and editing your contributions:
224
224
225
-
- **[Vale](https://vale.sh/)** - the `polkadot-mkdocs` repository contains configuration forVale, an open source NLP-powered linter for text. The configuration is a workin progress with a growing custom dictionary tailored toward software engineering, blockchain, and Polkadot terms. Running Vale against your files locally can serve as a first round of feedback to speed up the review process
225
+
- **[Vale](https://vale.sh/)**: The `polkadot-mkdocs` repository contains configuration forVale, an open source NLP-powered linter for text. The configuration is a workin progress with a growing custom dictionary tailored toward software engineering, blockchain, and Polkadot terms. Running Vale against your files locally can serve as a first round of feedback to speed up the review process.
226
226
227
227
To use Vale locally to screen your work:
228
228
229
-
1. Visit the Vale site and follow the [installation instructions](https://vale.sh/docs/vale-cli/installation/)
229
+
1. Visit the Vale site and follow the [installation instructions](https://vale.sh/docs/vale-cli/installation/).
230
230
2. From the `polkadot-mkdocs` directory, run the following in your terminal:
231
231
232
232
```bash
@@ -237,8 +237,8 @@ To use Vale locally to screen your work:
3. You can use CMD+click to open the file with the flagged items. This is especially helpful if you run Vale against a directory with multiple files
240
+
3. You can use CMD+click to open the file with the flagged items. This is especially helpful if you run Vale against a directory with multiple files.
241
241
242
-
4. Each flag tells you the line and location of the flagged item, the level of the flag (error, warning, or suggestion), and a suggestion for how to resolve the flag
242
+
4. Each flag tells you the line and location of the flagged item, the level of the flag (error, warning, or suggestion), and a suggestion for how to resolve the flag.
243
243
244
-
5. Once you have addressed the flagged items and made edits as needed, you can complete the normal steps to commit your changes and open a pull request to review for merge
244
+
5. Once you have addressed the flagged items and made edits as needed, you can complete the normal steps to commit your changes and open a pull request to review for merge.
Copy file name to clipboardExpand all lines: .snippets/code/develop/toolkit/interoperability/asset-transfer-api/reference/tx-result.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -133,6 +133,6 @@ A promise containing the result of constructing the transaction.
133
133
134
134
The `ConstructedFormat` type is a conditional type that returns a specific type based on the value of the TxResult `format` field.
135
135
136
-
- **Payload format** - if the format field is set to `'payload'`, the `ConstructedFormat` type will return a [`GenericExtrinsicPayload`](https://github.com/polkadot-js/api/blob/v15.8.1/packages/types/src/extrinsic/ExtrinsicPayload.ts#L87){target=\_blank}
137
-
- **Call format** - if the format field is set to `'call'`, the `ConstructedFormat` type will return a hexadecimal string (`0x${string}`). This is the encoded representation of the extrinsic call
138
-
- **Submittable format** - if the format field is set to `'submittable'`, the `ConstructedFormat` type will return a [`SubmittableExtrinsic`](https://github.com/polkadot-js/api/blob/v15.8.1/packages/api-base/src/types/submittable.ts#L56){target=\_blank}. This is a Polkadot.js type that represents a transaction that can be submitted to the blockchain
136
+
- **Payload format**: If the format field is set to `'payload'`, the `ConstructedFormat` type will return a [`GenericExtrinsicPayload`](https://github.com/polkadot-js/api/blob/v15.8.1/packages/types/src/extrinsic/ExtrinsicPayload.ts#L87){target=\_blank}.
137
+
- **Call format**: If the format field is set to `'call'`, the `ConstructedFormat` type will return a hexadecimal string (`0x${string}`). This is the encoded representation of the extrinsic call.
138
+
- **Submittable format**: If the format field is set to `'submittable'`, the `ConstructedFormat` type will return a [`SubmittableExtrinsic`](https://github.com/polkadot-js/api/blob/v15.8.1/packages/api-base/src/types/submittable.ts#L56){target=\_blank}. This is a Polkadot.js type that represents a transaction that can be submitted to the blockchain.
Copy file name to clipboardExpand all lines: develop/index.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,14 +11,14 @@ template: index-page.html
11
11
This guide is a starting point for developers who wish to build in the Polkadot ecosystem. To get the most from this section:
12
12
13
13
1. Identify your development pathway:
14
-
-[**Parachain developers**](#parachain-developers) - build, deploy, and maintain custom parachains with the Polkadot SDK
15
-
-[**Smart contract developers**](#smart-contract-developers) - leverage smart contracts and execute custom logic over existing chains to streamline your development process
16
-
-[**Application developers**](#application-developers) - leverage Polkadot's underlying protocol features to create solutions for your users to interact with the ecosystem
14
+
-**[Parachain developers](#parachain-developers)**: Build, deploy, and maintain custom parachains with the Polkadot SDK.
15
+
-**[Smart contract developers](#smart-contract-developers)**: Leverage smart contracts and execute custom logic over existing chains to streamline your development process.
16
+
-**[Application developers](#application-developers)**: Leverage Polkadot's underlying protocol features to create solutions for your users to interact with the ecosystem.
17
17
2. Use the sections under your pathway as follows:
18
-
-**Learn** - content to deepen your knowledge and understanding
19
-
-**Build** - connect to goal-oriented guides and step-by-step tutorials
20
-
-**Tools** - tools commonly used in your pathway
21
-
-**Resources** - resources for your pathway, including references, code repositories, and outside documentation
18
+
-**Learn**: Content to deepen your knowledge and understanding.
19
+
-**Build**: Connect to goal-oriented guides and step-by-step tutorials.
20
+
-**Tools**: Tools commonly used in your pathway.
21
+
-**Resources**: Resources for your pathway, including references, code repositories, and outside documentation.
22
22
23
23
## Development Pathways
24
24
@@ -36,9 +36,9 @@ graph TD
36
36
37
37
All three pathways can leverage Cross-Consensus Messaging (XCM) to create innovative cross-chain workflows and applications. To get started with XCM, see these resources:
38
38
39
-
-[**Introduction to XCM**](/develop/interoperability/intro-to-xcm/){target=\_blank} - introduces key concepts, core function definitions, and code examples
40
-
-[**XCM Tools**](/develop/toolkit/interoperability/xcm-tools/){target=\_blank} - provides an overview of popular XCM tools
41
-
-[**Tutorials for Managing XCM Channels**](/tutorials/interoperability/xcm-channels/){target=\_blank} - guides for using [Polkadot.js Apps](https://polkadot.js.org/apps/#/explorer){target=\_blank} UI to establish cross-chain messaging channels
39
+
-**[Introduction to XCM](/develop/interoperability/intro-to-xcm/){target=\_blank}**: Introduces key concepts, core function definitions, and code examples.
40
+
-**[XCM Tools](/develop/toolkit/interoperability/xcm-tools/){target=\_blank}**: Provides an overview of popular XCM tools.
41
+
-**[Tutorials for Managing XCM Channels](/tutorials/interoperability/xcm-channels/){target=\_blank}**: Guides for using [Polkadot.js Apps](https://polkadot.js.org/apps/#/explorer){target=\_blank} UI to establish cross-chain messaging channels.
Copy file name to clipboardExpand all lines: develop/interoperability/index.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,8 +8,8 @@ template: index-page.html
8
8
9
9
This section covers everything you need to know about building and implementing [Cross-Consensus Messaging (XCM)](/develop/interoperability/intro-to-xcm/){target=\_blank} solutions in the Polkadot ecosystem. Whether you're working on establishing cross-chain channels, sending and receiving XCM messages, or testing and debugging your cross-chain configurations, you'll find the essential resources and tools here to support your interoperability needs, regardless of your development focus.
10
10
11
-
- Not sure where to start? Visit the [Interoperability](/polkadot-protocol/parachain-basics/interoperability/){target=\_blank} overview page to explore different options and find the right fit for your project
12
-
- Ready to dive in? Head over to [Send XCM Messages](/develop/interoperability/send-messages/) to learn how to send a message cross-chain via XCM
11
+
- Not sure where to start? Visit the [Interoperability](/polkadot-protocol/parachain-basics/interoperability/){target=\_blank} overview page to explore different options and find the right fit for your project.
12
+
- Ready to dive in? Head over to [Send XCM Messages](/develop/interoperability/send-messages/) to learn how to send a message cross-chain via XCM.
0 commit comments