Skip to content

Commit 2c68642

Browse files
add image specs, versioning, and
style guide requirements to tutorials
1 parent dca3826 commit 2c68642

File tree

3 files changed

+14
-3
lines changed

3 files changed

+14
-3
lines changed

tutorials/QUICK_GUIDE.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ images/tutorials/[category]/[subcategory]/[tutorial-name]/
3030
3131
### 4. Working Code & Tests (Required)
3232
- All code examples must be tested and functional
33+
- **Always specify dependency versions** (e.g., `npm install [email protected]`)
3334
- Include verification steps
3435
- Test on clean environment before submitting
3536

@@ -64,8 +65,9 @@ images/tutorials/[category]/[subcategory]/[tutorial-name]/
6465

6566
## Image Requirements
6667

67-
- **Format**: `.webp` only
68+
- **Format**: `.webp` only
6869
- **Location**: `images/tutorials/[path]/`
70+
- **Naming**: `tutorial-name-01.webp`, `tutorial-name-02.webp`, etc.
6971
- **Dimensions**:
7072
- Desktop screenshots: 1512px width, variable height
7173
- Browser extensions: 400x600px

tutorials/STYLE_GUIDE.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Comprehensive guide for tutorial writing standards, formatting, and best practices. For quick reference, see [QUICK_GUIDE.md](QUICK_GUIDE.md).
44

5+
This guide covers tutorial-specific requirements and formatting. For general writing guidelines that apply to all documentation, refer to the [PaperMoon Documentation Style Guide](https://github.com/papermoonio/documentation-style-guide).
6+
57
## Table of Contents
68

79
- [Tutorial Structure](#tutorial-structure)
@@ -207,6 +209,9 @@ Store reusable code in the `.snippets` directory:
207209
- Use `!!!tip` to explain complex code sections
208210
- Test all code examples before submission
209211
- Include expected outputs where relevant
212+
- **Always specify dependency versions** in installation commands
213+
- Instead of: `npm install polkadot-api`
214+
- Use: `npm install [email protected]`
210215
211216
### Language Tags
212217
@@ -224,7 +229,9 @@ Common language tags to use:
224229
225230
- **Format**: All images must be in `.webp` format
226231
- **Location**: Store in `images/tutorials/[category]/[subcategory]/[tutorial-name]/`
227-
- **Naming**: Use descriptive names (e.g., `setup-wallet-connection.webp`)
232+
- **Naming**: Use sequential, descriptive names following this pattern:
233+
- `tutorial-name-01.webp`, `tutorial-name-02.webp`, etc.
234+
- Example: `set-up-a-template-01.webp`, `set-up-a-template-02.webp`
228235
- **Alt text**: Always include descriptive alt text for accessibility
229236
230237
### Screenshot Guidelines
@@ -240,7 +247,7 @@ Common language tags to use:
240247
241248
- **Desktop screenshots**: 1512px width, variable height
242249
- **Browser extension screenshots**: 400x600px
243-
- **Mobile screenshots**: 375px width (iPhone SE), variable height
250+
244251
245252
### Image Syntax
246253

tutorials/templates/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,11 @@ All templates follow a consistent structure:
9191
- **Be specific**: Replace generic examples with concrete, working code
9292
- **Test thoroughly**: Ensure all code examples work as described
9393
- **Include context**: Explain why each step is necessary
94+
- **Specify versions**: Always include specific versions for dependencies (e.g., `npm install [email protected]`)
9495
- **Add screenshots**: Visual aids improve understanding (use `.webp` format)
9596
- Desktop screenshots: 1512px width, variable height
9697
- Browser extensions: 400x600px
98+
- Naming: `tutorial-name-01.webp`, `tutorial-name-02.webp`, etc.
9799

98100
### File Organization
99101
When using templates, ensure you follow the proper file structure:

0 commit comments

Comments
 (0)