Skip to content

Commit

Permalink
renamed dev tutorials category, included wiki structure in contributi…
Browse files Browse the repository at this point in the history
…ng.md
  • Loading branch information
ase1590 committed Jan 14, 2025
1 parent ff2a2ee commit 705ccfc
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
11 changes: 11 additions & 0 deletions flip-wiki/docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,17 @@ The following guidelines should be kept in mind when submitting changes:
- Keep your writing tone non-biased and professional.
- if you upload any images, please try to keep them below 2 Megabytes in size.

## Wiki Structure
The General structure of this wiki is detailed below:

- **Getting Started:** contains basic info for using the device as well as commonly asked questions.
- **Subsystems:** contains general and technical information of the different device subsystems not related to any one specific project. Guides/Tutorials should NOT go here.
- **Development:** contains general and technical development information not related to any one specific project. Guides/Tutorials should NOT go here.
- **Guides & Tutorials:** Contains guides, tutorials, walkthroughs for any item related to the Flipper Zero.
- If you are making a guide or tutorial for a category, you will want to include it here.



## Text Formatting Examples
### Markdown

Expand Down
2 changes: 1 addition & 1 deletion flip-wiki/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ nav:
- Overview: javascript-overview.md

- Guides & Tutorials:
- Development:
- Development Tutorials:
- Designing Custom Fonts: tutorials/f0_fonts_guide/guide.md

- Site Info:
Expand Down

0 comments on commit 705ccfc

Please sign in to comment.