Skip to content

Commit 2d9794c

Browse files
tutorials contributing
1 parent 8d20dcf commit 2d9794c

12 files changed

+1707
-447
lines changed

.CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ This guide covers how to contribute to the documentation, including serving a lo
2020
- [Adding Code and Text Snippets](#adding-code-and-text-snippets)
2121
- [Adding Images](#adding-images)
2222
- [Search Engine Optimization (SEO)](#search-engine-optimization-seo)
23+
- [Contributing Tutorials](#contributing-tutorials)
2324
- [Tools for Editing](#tools-for-editing)
2425

2526
## Viewing Site Locally
@@ -218,6 +219,33 @@ Here are some resources to help you create good titles and descriptions for SEO:
218219

219220
In general, titles should be between 50 and 60 characters and descriptions should be between 120 and 160 characters.
220221

222+
## Contributing Tutorials
223+
224+
For step-by-step tutorials, we have a specialized workflow and dedicated guides. Start with the [**tutorials overview**](tutorials/README.md) to see all available options, or jump directly to:
225+
226+
### Quick Tutorial Contributing
227+
- **[Quick Guide](tutorials/QUICK_GUIDE.md)** - Essential requirements for experienced contributors
228+
- Focus on working code and clear instructions
229+
- Everything else is optional and can be refined during review
230+
231+
### Detailed Tutorial Guidelines
232+
- **[Style Guide](tutorials/STYLE_GUIDE.md)** - Comprehensive guide with detailed formatting rules
233+
- **[Templates](tutorials/templates/)** - Ready-to-use templates for different tutorial categories:
234+
- Polkadot SDK tutorials
235+
- Smart contracts tutorials
236+
- XCM/Interoperability tutorials
237+
- dApps tutorials
238+
- Governance tutorials
239+
240+
### Tutorial Categories
241+
- **polkadot-sdk/**: Parachains, pallets, runtime development
242+
- **smart-contracts/**: EVM contracts, ink! contracts, demo applications
243+
- **interoperability/**: XCM operations, cross-chain workflows
244+
- **dapps/**: Frontend development, API integrations
245+
- **onchain-governance/**: Proposals, voting, delegation
246+
247+
Tutorials follow a different structure than general documentation and have specific requirements for metadata, file organization, and navigation updates.
248+
221249
## Tools for Editing
222250

223251
There are a few tools you may find useful for proofreading and editing your contributions:

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ The content in this repository is displayed on the Polkadot documentation site g
1010

1111
## Contributing
1212

13-
If you're interested in contributing to this repository, please clone the repo, make changes, and open a PR ✨. Please review the guidelines in the [CONTRIBUTING file](.CONTRIBUTING.md) before making any changes.
13+
If you're interested in contributing to this repository, please clone the repo, make changes, and open a PR ✨. Please review the guidelines in the [CONTRIBUTING file](CONTRIBUTING.md) before making any changes.
14+
15+
For tutorial contributions specifically, see the [tutorials contributing overview](tutorials/README.md).
1416

1517
Thank you for taking the time to contribute to this repository 💜.
1618

0 commit comments

Comments
 (0)