Skip to content

Commit 8fe54b4

Browse files
update contributind.md
1 parent fbc0737 commit 8fe54b4

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

.CONTRIBUTING/tutorials/.CONTRIBUTING.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,25 +84,30 @@ categories: Category1, Category2
8484
Once you've defined your tutorial path, ensure images and code snippets follow the same structure.
8585

8686
**Tutorial file:**
87+
8788
```
8889
tutorials/[category]/[subcategory]/[tutorial-name].md
8990
```
9091

9192
**Supporting files:**
93+
9294
```
9395
images/tutorials/[category]/[subcategory]/[tutorial-name]/
9496
.snippets/code/tutorials/[category]/[subcategory]/[tutorial-name]/
9597
```
9698

9799
**Image naming convention:**
100+
98101
```
99102
images/tutorials/[category]/[subcategory]/[tutorial-name]/[tutorial-name-01.webp]
100103
```
104+
101105
Where the number will be 01, 02, 03, etc.
102106

103-
### 3. Navigation Update (Critical)
107+
### 3. Navigation Update
104108

105109
**Must update `.nav.yml` files** or your tutorial won't appear in the left-side menu:
110+
106111
```yaml
107112
# In appropriate .nav.yml file
108113
- 'Display Title': tutorial-filename.md
@@ -129,21 +134,27 @@ Where the number will be 01, 02, 03, etc.
129134
# Tutorial Title
130135
131136
## Introduction
137+
132138
[Brief explanation of what users will learn/build]
133139
134140
## Prerequisites
141+
135142
- [Required knowledge/tools]
136143
137144
## [Action-Oriented Section Title]
145+
138146
[Instructions with commands]
139147
140148
## [Another Action-Oriented Section Title]
149+
141150
[Instructions with commands]
142151
143152
## Verification
153+
144154
[How to confirm it worked]
145155
146156
## Where to Go Next
157+
147158
[Related tutorials]
148159
```
149160

@@ -177,7 +188,7 @@ If you choose the self-managed path, you must follow **all** requirements in [ST
177188

178189
- Complete metadata specifications
179190
- Image optimization and formatting
180-
- Navigation file updates (.nav.yml)
191+
- Navigation file updates (`.nav.yml`)
181192
- Advanced style and formatting rules
182193
- SEO optimization requirements
183194

0 commit comments

Comments
 (0)