Skip to content

Commit b2ab262

Browse files
fix style
1 parent d3ea20a commit b2ab262

File tree

6 files changed

+21
-38
lines changed

6 files changed

+21
-38
lines changed

.CONTRIBUTING/tutorials/.CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,13 @@
3737
**Allow the Polkadot Docs team to handle formatting and style**
3838

3939
**Benefits:**
40+
4041
- Faster review process
4142
- Fewer style-related review comments
4243
- Team handles technical formatting requirements
4344

4445
**Your responsibility:**
46+
4547
- Working code and clear instructions
4648
- Following essential requirements below
4749

@@ -63,6 +65,7 @@
6365
## Essential Requirements
6466

6567
### 1. Metadata (Required)
68+
6669
```yaml
6770
---
6871
title: Tutorial Title (max 45 chars)
@@ -73,20 +76,23 @@ categories: Category1, Category2
7376
```
7477

7578
### 2. File Structure (Required)
79+
7680
```
7781
tutorials/[category]/[subcategory]/[tutorial-name].md
7882
images/tutorials/[category]/[subcategory]/[tutorial-name]/
7983
.snippets/code/tutorials/[category]/[subcategory]/[tutorial-name]/
8084
```
8185

8286
### 3. Navigation Update (Critical)
83-
**Must update `.nav.yml` files** or your tutorial won't appear:
87+
88+
**Must update `.nav.yml` files** or your tutorial won't appear in the left-side menu:
8489
```yaml
8590
# In appropriate .nav.yml file
8691
- 'Display Title': tutorial-filename.md
8792
```
8893
8994
### 4. Working Code & Tests (Required)
95+
9096
- All code examples must be tested and functional
9197
- **Always specify dependency versions** (e.g., `npm install [email protected]`)
9298
- Include verification steps

.CONTRIBUTING/tutorials/STYLE_GUIDE.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,6 @@ Use these for important information:
351351
- `!!!tip` - Helpful tips and shortcuts
352352
- `!!!note` - Important information to remember
353353
- `!!!warning` - Potential issues or caveats
354-
- `!!!danger` - Critical warnings about destructive actions
355354

356355
### Lists and Procedures
357356

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ Enhance your dApp development skills:
311311

312312
## Additional Resources
313313

314-
- [Polkadot.js API Documentation](https://polkadot.js.org/docs/)
315-
- [PAPI Documentation](https://papi.how/)
316-
- [Polkadot Developer Console](https://console.polkadot.io/)
317-
- [Substrate Connect](https://substrate.io/developers/substrate-connect/)
314+
- [Polkadot.js API Documentation](https://polkadot.js.org/docs/){target=\_blank}
315+
- [PAPI Documentation](https://papi.how/){target=\_blank}
316+
- [Polkadot Developer Console](https://console.polkadot.io/){target=\_blank}
317+
- [Substrate Connect](https://substrate.io/developers/substrate-connect/){target=\_blank}

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ Continue your governance journey:
184184

185185
## Additional Resources
186186

187-
- [Polkadot Governance Wiki](https://wiki.polkadot.network/docs/learn-governance)
188-
- [OpenGov Documentation](https://wiki.polkadot.network/docs/learn-opengov)
189-
- [Polkassembly](https://polkadot.polkassembly.io/) - Governance discussion platform
190-
- [Subsquare](https://www.subsquare.io/) - Alternative governance interface
187+
- [Polkadot Governance Wiki](https://wiki.polkadot.network/docs/learn-governance){target=\_blank}
188+
- [OpenGov Documentation](https://wiki.polkadot.network/docs/learn-opengov){target=\_blank}
189+
- [Polkassembly](https://polkadot.polkassembly.io/){target=\_blank} - Governance discussion platform
190+
- [Subsquare](https://www.subsquare.io/){target=\_blank} - Alternative governance interface

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

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -82,15 +82,6 @@ Verify everything works by:
8282

8383
[Optional advanced steps for intermediate/advanced tutorials]
8484

85-
## Troubleshooting
86-
87-
Common issues and solutions:
88-
89-
- **Issue**: Build fails with dependency errors
90-
- **Solution**: Update dependencies and check Rust version
91-
92-
- **Issue**: Runtime compilation errors
93-
- **Solution**: Verify pallet configuration in runtime
9485

9586
## Where to Go Next
9687

@@ -101,6 +92,6 @@ Continue your Polkadot SDK journey with:
10192

10293
## Additional Resources
10394

104-
- [Polkadot SDK Documentation](https://paritytech.github.io/polkadot-sdk/)
105-
- [Substrate Developer Hub](https://docs.substrate.io/)
106-
- [Polkadot Wiki - Developers](https://wiki.polkadot.network/docs/build-index)
95+
- [Polkadot SDK Documentation](https://paritytech.github.io/polkadot-sdk/){target=\_blank}
96+
- [Polkadot Docs](https://docs.polkadot.com){target=\_blank}
97+
- [Polkadot Wiki - Developers](https://wiki.polkadot.network/docs/build-index){target=\_blank}

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

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -90,18 +90,6 @@ describe("YourContract", function () {
9090
});
9191
```
9292

93-
### For ink! Contracts:
94-
```rust
95-
#[cfg(test)]
96-
mod tests {
97-
use super::*;
98-
99-
#[ink::test]
100-
fn default_works() {
101-
// Test implementation
102-
}
103-
}
104-
```
10593

10694
Run tests:
10795
```bash
@@ -155,7 +143,6 @@ Extend your smart contract skills:
155143

156144
## Additional Resources
157145

158-
- [Remix IDE](https://remix.ethereum.org/)
159-
- [ink! Documentation](https://use.ink/)
160-
- [OpenZeppelin Contracts](https://openzeppelin.com/contracts/)
161-
- [Hardhat Documentation](https://hardhat.org/)
146+
- [Polkadot Remix IDE](https://remix.polkadot.io/){target=\_blank}
147+
- [OpenZeppelin Contracts](https://openzeppelin.com/contracts/){target=\_blank}
148+
- [Hardhat Documentation](https://hardhat.org/){target=\_blank}

0 commit comments

Comments
 (0)