liz/flipperzero-firmware
liz/flipperzero-firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

info about wiki editing

Browse Source
This commit is contained in:
aanper 2020-08-15 10:16:00 +03:00
parent 6995c561cf
commit c4af2a1eb7
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
wiki/Contributing.md
View File

@ -24,10 +24,17 @@ If you are just beginning in Flipper, **Read the [wiki](https://github.com/Flipp
* Some sections mark as `not documented`. There is some implementation and you can add some documentation here. * Some sections mark as `not documented`. There is some implementation and you can add some documentation here.
* If section of wiki has no mark, this is actual documentation for part of Flipper. * If section of wiki has no mark, this is actual documentation for part of Flipper.
## Wiki storage `(not implemented)` ## Wiki editing `(not implemented)`
All wiki files storage in main repository in `wiki` folder. You can change wiki by creating PR with `documentation` label. After merge to master, wiki contents copying to GitHub `Wiki` section. All wiki files storage in main repository in `wiki` folder. You can change wiki by creating PR with `documentation` label. After merge to master, wiki contents copying to GitHub `Wiki` section.
### For maintainers
If you want to update wiki:
* place `flipperzero-firmware-community.wiki` folder repo in main repo's root folder (do not add it to git!)
* call `./wiki-deploy.sh` srcipt
# Maintainers # Maintainers
Every section/page of wiki and related part of code has its own maintainers. Maintainers list and related code folders is placed at the bottom of page or section. Every section/page of wiki and related part of code has its own maintainers. Maintainers list and related code folders is placed at the bottom of page or section.