Skip to content

Commit d3ea20a

Browse files
fixed styles in contributing tutorial
1 parent 4f87610 commit d3ea20a

File tree

9 files changed

+35
-82
lines changed

9 files changed

+35
-82
lines changed

.CONTRIBUTING/tutorials/templates/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ For tutorials covering:
99
- Parachain development
1010
- Custom pallet creation
1111
- Runtime configuration
12-
- Substrate chain setup
12+
- Polkadot SDK chain setup
1313
- Testing and benchmarking
1414

1515
### 💎 [Smart Contracts Template](smart-contracts-template.md)

.CONTRIBUTING/tutorials/templates/dapps-template.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ my-polkadot-dapp/
5353

5454
## Step 2: API Connection Setup
5555

56-
Create a connection to the Polkadot/Substrate network:
56+
Create a connection to the Polkadot network:
5757

5858
```typescript
5959
// src/hooks/usePolkadotApi.ts
@@ -290,18 +290,6 @@ const networks = {
290290
};
291291
```
292292

293-
## Troubleshooting
294-
295-
Common dApp development issues:
296-
297-
- **Issue**: Extension not detected
298-
- **Solution**: Check if Polkadot.js extension is installed and enabled
299-
300-
- **Issue**: API connection fails
301-
- **Solution**: Verify WebSocket endpoint and network connectivity
302-
303-
- **Issue**: Transaction fails with "Invalid transaction"
304-
- **Solution**: Check account balance, nonce, and transaction parameters
305293

306294
## Deployment
307295

@@ -323,7 +311,7 @@ Enhance your dApp development skills:
323311

324312
## Additional Resources
325313

326-
- [Polkadot.js API Documentation](https://polkadot.js.org/docs/)
314+
- [Polkadot.js API Documentation](https://polkadot.js.org/docs/)
327315
- [PAPI Documentation](https://papi.how/)
328316
- [Polkadot Developer Console](https://console.polkadot.io/)
329317
- [Substrate Connect](https://substrate.io/developers/substrate-connect/)

.CONTRIBUTING/tutorials/templates/governance-template.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -175,19 +175,6 @@ Analyze the outcome of your governance participation:
175175
- Regularly review delegate performance
176176
- Maintain some direct voting for important issues
177177

178-
## Troubleshooting
179-
180-
Common governance participation issues:
181-
182-
- **Issue**: Transaction fails with "VotingPeriodLow"
183-
- **Solution**: Increase conviction or voting balance
184-
185-
- **Issue**: Cannot submit proposal
186-
- **Solution**: Check minimum deposit requirements and account balance
187-
188-
- **Issue**: Voting transaction rejected
189-
- **Solution**: Verify referendum is in voting period and parameters are correct
190-
191178
## Where to Go Next
192179

193180
Continue your governance journey:

.CONTRIBUTING/tutorials/templates/polkadot-sdk-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Before starting, ensure you have:
3030

3131
```bash
3232
# Commands for initial setup
33-
cargo install --git https://github.com/paritytech/polkadot-sdk polkadot-parachain-bin --locked
33+
git clone -b INSERT_TAG_HERE https://github.com/paritytech/polkadot-sdk-parachain-template.git parachain-template
3434
```
3535

3636
Expected output:

.CONTRIBUTING/tutorials/templates/smart-contracts-template.md

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -61,30 +61,6 @@ contract YourContract {
6161
// Implementation
6262
}
6363
}
64-
```
65-
66-
```rust
67-
// For ink! contracts - example structure
68-
#[ink::contract]
69-
mod your_contract {
70-
#[ink(storage)]
71-
pub struct YourContract {
72-
value: bool,
73-
}
74-
75-
impl YourContract {
76-
#[ink(constructor)]
77-
pub fn new(init_value: bool) -> Self {
78-
Self { value: init_value }
79-
}
80-
81-
#[ink(message)]
82-
pub fn flip(&mut self) {
83-
self.value = !self.value;
84-
}
85-
}
86-
}
87-
```
8864
8965
## Step 3: Contract Implementation
9066
@@ -146,13 +122,6 @@ Deploy your contract:
146122
npx hardhat run scripts/deploy.js --network [testnet-name]
147123
```
148124

149-
### For ink! Contracts:
150-
```bash
151-
# Build contract
152-
cargo contract build
153-
154-
# Deploy to testnet (using contracts UI or CLI)
155-
```
156125

157126
## Step 6: Interaction and Verification
158127

@@ -175,15 +144,7 @@ Test contract functionality:
175144
- Cross-contract calls
176145
- Upgradeable patterns
177146

178-
## Troubleshooting
179-
180-
Common deployment and interaction issues:
181-
182-
- **Issue**: Gas estimation failed
183-
- **Solution**: Check contract logic and increase gas limit
184147

185-
- **Issue**: Transaction reverts
186-
- **Solution**: Verify function parameters and contract state
187148

188149
## Where to Go Next
189150

.CONTRIBUTING/tutorials/templates/xcm-interoperability-template.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -138,19 +138,6 @@ fn test_cross_chain_transfer() {
138138
}
139139
```
140140

141-
## Troubleshooting
142-
143-
Common XCM issues and solutions:
144-
145-
- **Issue**: XCM execution failed with `TooExpensive`
146-
- **Solution**: Increase fee asset amount or adjust weight limit
147-
148-
- **Issue**: Assets stuck in sovereign account
149-
- **Solution**: Check destination chain configuration and asset registration
150-
151-
- **Issue**: Transaction not appearing on destination
152-
- **Solution**: Verify network connectivity and chain synchronization
153-
154141
## Advanced XCM Patterns [For Advanced Tutorials]
155142

156143
[Include for intermediate/advanced tutorials:]

llms-full.txt

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,7 @@ Doc-Page: https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/re
176176
Doc-Page: https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/polkadot-protocol/smart-contract-basics/networks.md
177177
Doc-Page: https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/polkadot-protocol/smart-contract-basics/overview.md
178178
Doc-Page: https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/polkadot-protocol/smart-contract-basics/polkavm-design.md
179+
Doc-Page: https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/tutorials/README.md
179180
Doc-Page: https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/tutorials/dapps/index.md
180181
Doc-Page: https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/tutorials/dapps/remark-tutorial.md
181182
Doc-Page: https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/tutorials/index.md
@@ -29651,6 +29652,34 @@ The compilation process integrates several specialized components:
2965129652
4. **PVM linker**: Links the RISC-V ELF object into a final PolkaVM blob with metadata.
2965229653
--- END CONTENT ---
2965329654

29655+
Doc-Content: https://docs.polkadot.com/tutorials/README/
29656+
--- BEGIN CONTENT ---
29657+
# Contributing Tutorials
29658+
29659+
## Quick Start
29660+
29661+
Ready to contribute a tutorial? Get started here:
29662+
29663+
👉 **[Tutorial Contributing Guide](../.CONTRIBUTING/tutorials/.CONTRIBUTING.md)**
29664+
29665+
## What You'll Find
29666+
29667+
- **Requirements** - Essential metadata and file structure
29668+
- **Categories** - Where your tutorial belongs (SDK, smart contracts, XCM, etc.)
29669+
- **Templates** - Ready-to-use templates for different tutorial types
29670+
- **Guidelines** - Code standards, testing, and submission process
29671+
29672+
## Tutorial Categories
29673+
29674+
- **polkadot-sdk/** - Parachains, pallets, runtime development
29675+
- **smart-contracts/** - Solidity (EVM, Revm, PVM), demo applications
29676+
- **interoperability/** - XCM operations, cross-chain workflows
29677+
- **dapps/** - Frontend integration, API usage
29678+
- **onchain-governance/** - Proposals, OpenGov operations
29679+
29680+
Start with working code, clear steps, and we'll help you polish the rest!
29681+
--- END CONTENT ---
29682+
2965429683
Doc-Content: https://docs.polkadot.com/tutorials/dapps/
2965529684
--- BEGIN CONTENT ---
2965629685
---

llms.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,7 @@
174174
- [Networks for Polkadot Hub Smart Contracts](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/polkadot-protocol/smart-contract-basics/networks.md): Explore the available networks for smart contract development on Polkadot Hub, including Westend Hub, Kusama Hub, and Polkadot Hub.
175175
- [Smart Contracts Basics Overview](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/polkadot-protocol/smart-contract-basics/overview.md): Learn how developers can build smart contracts on Polkadot by leveraging either Wasm/ink! or EVM contracts across many parachains.
176176
- [PolkaVM Design](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/polkadot-protocol/smart-contract-basics/polkavm-design.md): Discover PolkaVM, a high-performance smart contract VM for Polkadot, enabling Ethereum compatibility via pallet_revive, Solidity support & optimized execution.
177+
- [Untitled](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/tutorials/README.md): No description available.
177178
- [Decentralized Application Tutorials](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/tutorials/dapps/index.md): Explore step-by-step tutorials for exploring the world of building decentralized applications using the toolkits that Polkadot provides.
178179
- [PAPI Account Watcher Tutorial](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/tutorials/dapps/remark-tutorial.md): Build a CLI app that listens to on-chain events using the Polkadot API and responds to specific messages for a given account.
179180
- [Tutorials](https://raw.githubusercontent.com/polkadot-developers/polkadot-docs/refs/heads/master/tutorials/index.md): Explore step-by-step tutorials for building in Polkadot, from parachain deployment and testing to cross-chain asset creation and XCM channel management.

tutorials/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Ready to contribute a tutorial? Get started here:
1616
## Tutorial Categories
1717

1818
- **polkadot-sdk/** - Parachains, pallets, runtime development
19-
- **smart-contracts/** - EVM, ink!, demo applications
19+
- **smart-contracts/** - Solidity (EVM, Revm, PVM), demo applications
2020
- **interoperability/** - XCM operations, cross-chain workflows
2121
- **dapps/** - Frontend integration, API usage
2222
- **onchain-governance/** - Proposals, OpenGov operations

0 commit comments

Comments
 (0)