11# Tutorial Templates
22
3- This folder contains templates for different types of Polkadot tutorials to help you get started quickly and maintain consistency across all documentation.
3+ This folder includes templates for various types of Polkadot tutorials to help you get started quickly and keep consistency throughout all documentation.
44
55## Available Templates
66
77### 📦 [ Polkadot SDK Template] ( polkadot-sdk-template.md )
8+
89For tutorials covering:
10+
911- Parachain development
1012- Custom pallet creation
1113- Runtime configuration
1214- Polkadot SDK chain setup
1315- Testing and benchmarking
1416
1517### 💎 [ Smart Contracts Template] ( smart-contracts-template.md )
18+
1619For tutorials covering:
20+
1721- EVM smart contracts (Solidity)
1822- Contract deployment and interaction
1923- DeFi applications
2024- Token contracts
2125
2226### 🌐 [ XCM/Interoperability Template] ( xcm-interoperability-template.md )
27+
2328For tutorials covering:
29+
2430- Cross-chain asset transfers
2531- XCM message construction
2632- Channel management (HRMP)
2733- Cross-chain testing
2834- Multi-chain workflows
2935
3036### 🖥️ [ dApps Template] ( dapps-template.md )
37+
3138For tutorials covering:
39+
3240- Frontend development
3341- Wallet integration
3442- API connections (Polkadot.js, PAPI)
3543- User interface design
3644- Chain interaction
3745
3846### 🗳️ [ Governance Template] ( governance-template.md )
47+
3948For tutorials covering:
49+
4050- Proposal creation and submission
4151- Voting and delegation
4252- OpenGov participation
@@ -58,7 +68,9 @@ For tutorials covering:
5868## Template Structure Explained
5969
6070### Frontmatter Metadata
71+
6172Every template includes the required metadata fields:
73+
6274``` yaml
6375---
6476title : [Keep under 45 characters for SEO]
@@ -69,6 +81,7 @@ categories: [Relevant, Comma, Separated, Categories]
6981```
7082
7183### Common Sections
84+
7285All templates follow a consistent structure:
7386
74871 . ** Introduction** : Context and learning objectives
@@ -79,30 +92,14 @@ All templates follow a consistent structure:
79926 . ** Where to Go Next** : Related tutorials and next steps
80937 . ** Additional Resources** : External links and references
8194
82- ### Placeholder Format
83- - ` [Square brackets] ` : Replace with your specific content
84- - ` [Optional sections] ` : Include only if relevant to your tutorial
85- - Code comments: Replace example code with your implementations
86-
8795## Best Practices
8896
8997### Content Guidelines
98+
9099- ** Be specific** : Replace generic examples with concrete, working code
91100- ** Test thoroughly** : Ensure all code examples work as described
92101- ** Include context** : Explain why each step is necessary
93102- ** Specify versions
** : Always include specific versions for dependencies (e.g.,
` npm install [email protected] ` )
94- - ** Add screenshots** : Visual aids improve understanding (use ` .webp ` format)
95- - Desktop screenshots: 1512px width, variable height
96- - Browser extensions: 400x600px
97- - Naming: ` tutorial-name-01.webp ` , ` tutorial-name-02.webp ` , etc.
98-
99- ### File Organization
100- When using templates, ensure you follow the proper file structure:
101- ```
102- tutorials/[category]/[subcategory]/[tutorial-name].md
103- images/tutorials/[category]/[subcategory]/[tutorial-name]/
104- .snippets/code/tutorials/[category]/[subcategory]/[tutorial-name]/
105- ```
106103
107104### Navigation
108105** Critical** : Always update the appropriate ` .nav.yml ` files when adding a new tutorial:
@@ -128,7 +125,6 @@ Feel free to add sections relevant to your tutorial:
128125Replace template code with your specific examples:
129126- Use real, tested code snippets
130127- Include error handling where appropriate
131- - Show expected outputs (use ` termynal` element for terminal outputs)
132128- Provide alternative approaches when relevant
133129
134130## Questions and Support
0 commit comments