Skip to content

Commit 2b28b44

Browse files
update syle
1 parent b2ab262 commit 2b28b44

File tree

3 files changed

+23
-4
lines changed

3 files changed

+23
-4
lines changed

.CONTRIBUTING/tutorials/.CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,14 +49,15 @@
4949

5050
**Important:** Enable "Allow edits by maintainers" on your PR
5151

52-
**Recommendation:** Even with team assistance, reviewing the [STYLE_GUIDE.md](STYLE_GUIDE.md) helps you create better tutorials from the start.
52+
**Required:** You must read the [STYLE_GUIDE.md](STYLE_GUIDE.md) to understand all requirements. The difference is that with the team-assisted path, they will have the bandwidth to handle the review process.
5353

5454
### Self-Managed Path
5555
**Handle all formatting and style requirements yourself**
5656

5757
**Full control** over your tutorial format and style
5858
**More review rounds** - you must fix all style issues
5959
**Required reading:** [STYLE_GUIDE.md](STYLE_GUIDE.md)
60+
**For expedited review:** Also read the PaperMoon Documentation Style Guide
6061

6162
---
6263

.CONTRIBUTING/tutorials/STYLE_GUIDE.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,12 +202,20 @@ Store reusable code in the `.snippets` directory:
202202

203203
### Including Code Snippets
204204

205-
```markdown
205+
206206
```bash
207207
--8<-- 'code/tutorials/polkadot-sdk/parachains/setup.sh'
208208
```
209+
210+
211+
You can also use line numbers and include specific lines:
212+
213+
214+
```bash linenums="1"
215+
--8<-- 'code/tutorials/polkadot-sdk/parachains/setup.sh:10:20'
209216
```
210217

218+
211219
### Code Block Guidelines
212220

213221
- Always specify language for syntax highlighting

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

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,19 @@ Before starting, ensure you have:
2525
- Basic understanding of XCM concepts
2626
- Access to testnet networks (if applicable)
2727

28-
## Step 1: Network Setup and Configuration
28+
## Step 1: Chopsticks Environment Setup
2929

30-
[Configure networks and prepare for cross-chain operations]
30+
First, we'll set up Chopsticks to simulate the network environment for XCM testing.
31+
32+
### Install Chopsticks
33+
34+
```bash
35+
npm install @acala-network/chopsticks@latest
36+
```
37+
38+
### Configure Networks
39+
40+
Create a chopsticks configuration file for your networks:
3141

3242
### Network Configuration
3343
```javascript

0 commit comments

Comments
 (0)