Skip to content

Commit 7676711

Browse files
resolve comments
1 parent 2b28b44 commit 7676711

File tree

4 files changed

+43
-21
lines changed

4 files changed

+43
-21
lines changed

.CONTRIBUTING/tutorials/.CONTRIBUTING.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
## Choose Your Contributing Path
3535

3636
### Team-Assisted Path (Recommended)
37+
3738
**Allow the Polkadot Docs team to handle formatting and style**
3839

3940
**Benefits:**
@@ -52,12 +53,14 @@
5253
**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.
5354

5455
### Self-Managed Path
56+
5557
**Handle all formatting and style requirements yourself**
5658

5759
**Full control** over your tutorial format and style
5860
**More review rounds** - you must fix all style issues
5961
**Required reading:** [STYLE_GUIDE.md](STYLE_GUIDE.md)
60-
**For expedited review:** Also read the PaperMoon Documentation Style Guide
62+
**For expedited review:** Also read the [PaperMoon Documentation Style Guide](https://github.com/papermoonio/documentation-style-guide).
63+
6164

6265
---
6366

@@ -78,12 +81,25 @@ categories: Category1, Category2
7881

7982
### 2. File Structure (Required)
8083

84+
Once you've defined your tutorial path, ensure images and code snippets follow the same structure.
85+
86+
**Tutorial file:**
8187
```
8288
tutorials/[category]/[subcategory]/[tutorial-name].md
89+
```
90+
91+
**Supporting files:**
92+
```
8393
images/tutorials/[category]/[subcategory]/[tutorial-name]/
8494
.snippets/code/tutorials/[category]/[subcategory]/[tutorial-name]/
8595
```
8696

97+
**Image naming convention:**
98+
```
99+
images/tutorials/[category]/[subcategory]/[tutorial-name]/[tutorial-name-01.webp]
100+
```
101+
Where the number will be 01, 02, 03, etc.
102+
87103
### 3. Navigation Update (Critical)
88104

89105
**Must update `.nav.yml` files** or your tutorial won't appear in the left-side menu:
@@ -118,7 +134,10 @@ images/tutorials/[category]/[subcategory]/[tutorial-name]/
118134
## Prerequisites
119135
- [Required knowledge/tools]
120136
121-
## Step 1: [Action]
137+
## [Action-Oriented Section Title]
138+
[Instructions with commands]
139+
140+
## [Another Action-Oriented Section Title]
122141
[Instructions with commands]
123142
124143
## Verification
@@ -128,6 +147,8 @@ images/tutorials/[category]/[subcategory]/[tutorial-name]/
128147
[Related tutorials]
129148
```
130149

150+
**Note:** Use action-oriented section titles (e.g., "Environment Setup", "Client Configuration") instead of generic "Step 1", "Step 2" format.
151+
131152
## Image Requirements
132153

133154
- **Format**: `.webp` only
@@ -140,6 +161,7 @@ images/tutorials/[category]/[subcategory]/[tutorial-name]/
140161

141162
## Submission Checklist
142163

164+
- [ ] Tutorial follows a clear storytelling structure with logical flow
143165
- [ ] Metadata complete
144166
- [ ] Working code tested
145167
- [ ] Images in `.webp` format

.CONTRIBUTING/tutorials/STYLE_GUIDE.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -71,20 +71,15 @@ Before writing, determine:
7171

7272
### Writing Best Practices
7373

74+
**Note**: For comprehensive writing guidelines, refer to the [PaperMoon Documentation Style Guide](https://github.com/papermoonio/documentation-style-guide). The following are tutorial-specific essentials:
75+
7476
1. **Use active voice**: "You will build..." instead of "A blockchain will be built..."
7577
2. **Be specific**: Provide exact commands, file paths, and parameter values
7678
3. **Include context**: Explain why each step is necessary
7779
4. **Use consistent terminology**: Follow established Polkadot vocabulary
78-
5. **Provide alternatives**: When multiple approaches exist, mention them
79-
6. **Add warnings**: Use `!!!warning` for important caveats
80-
81-
### Tone and Style
82-
83-
- Write in second person ("you will", "your application")
84-
- Use clear, concise sentences
85-
- Break up long paragraphs
86-
- Use bullet points for lists and options
87-
- Number steps for procedures
80+
5. **Tutorial language**: Use "you" when addressing the reader, "we" when working through steps together
81+
6. **Structure clearly**: Use bullet points for lists, number steps for procedures
82+
7. **Break up content**: Keep paragraphs concise and readable
8883

8984
## Metadata Requirements
9085

@@ -220,7 +215,8 @@ You can also use line numbers and include specific lines:
220215

221216
- Always specify language for syntax highlighting
222217
- Include file names when showing file contents
223-
- Use `!!!tip` to explain complex code sections
218+
- Use `!!!tip` sparingly to explain complex code sections (avoid admonitions when possible)
219+
- For collapsible code sections, use: `??? code "<Title>"`
224220
- Test all code examples before submission
225221
- Include expected outputs where relevant
226222
- **Always specify dependency versions** in installation commands
@@ -257,6 +253,7 @@ Common language tags to use:
257253
- Update screenshots when UI changes
258254

259255
#### Image Dimensions
256+
260257
**Important**: Use these specific dimensions to avoid rework during review:
261258

262259
- **Desktop screenshots**: 1512px width, variable height
@@ -329,13 +326,13 @@ categories: [Categories]
329326
## Overview
330327
[Architecture or process overview]
331328
332-
## Part 1: [Section Title]
333-
### Step 1: [Substep]
334-
### Step 2: [Substep]
329+
## [Action-Oriented Section Title]
330+
### [Specific Task or Setup]
331+
### [Another Specific Task]
335332
336-
## Part 2: [Section Title]
337-
### Step 1: [Substep]
338-
### Step 2: [Substep]
333+
## [Another Action-Oriented Section]
334+
### [Implementation Task]
335+
### [Testing or Verification]
339336
340337
## Testing and Verification
341338
[Comprehensive testing instructions]

.CONTRIBUTING/tutorials/templates/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ Feel free to add sections relevant to your tutorial:
129129
Replace template code with your specific examples:
130130
- Use real, tested code snippets
131131
- Include error handling where appropriate
132-
- Show expected outputs
132+
- Show expected outputs (use `termynal` element for terminal outputs)
133133
- Provide alternative approaches when relevant
134134

135135
## Questions and Support

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Before starting, ensure you have:
2424
- Basic understanding of [required concepts]
2525
- [Tokens/accounts if needed]
2626

27-
## Step 1: Project Setup
27+
## Environment Setup
2828

2929
[Set up the development environment and project structure]
3030

@@ -33,6 +33,9 @@ Before starting, ensure you have:
3333
git clone -b INSERT_TAG_HERE https://github.com/paritytech/polkadot-sdk-parachain-template.git parachain-template
3434
```
3535

36+
!!! note
37+
Replace `INSERT_TAG_HERE` with the actual tag or branch of the parachain template you want to use (e.g., `polkadot-stable2412`).
38+
3639
Expected output:
3740
```
3841
[Show expected terminal output]

0 commit comments

Comments
 (0)