U|BFT3V+NRkwPHZz8qG!>mt@b@rNz-%D^c61B$SsLoRy%V
hk7CTFqqvBw1^to?MAu?!5Irb-5zsVn!wmc>1K*mIQ~m$|
literal 0
HcmV?d00001
diff --git a/contributing/documenting/index.html b/contributing/documenting/index.html
index a89282d..20e890d 100644
--- a/contributing/documenting/index.html
+++ b/contributing/documenting/index.html
@@ -221,6 +221,10 @@
@@ -228,8 +232,48 @@
Documenting
Without clear documentation, new members to the community have no clear instruction on how they can help to make Status better. We truly value contributions that help to improve our documentation; whether that be tutorials for users, additions to the FAQs, or more granular instructions for developers - it all adds up and our community appreciates it :)
Our Wiki is powered by MKDocs, and is on: https://github.com/status-im/wiki.status.im, and if you spot any errors, find parts of the documentation confusing, or have some suggestions on how we could have clearer communication we'd love your help, and feel free to let us know via the Status Slack.
-
// TODO Create Documenting Guide
-
// TODO Create Documentation Guidelines
+Documenting Guide
+It's fairly difficult to write a general documentation guide as how you document stuff will depend on what it is you are trying to explain. The most basic stuff to know is that MKDocs uses markdown as it's primary language, although you can also write your guides using inline HTML as well. Please go here for more detailed info on this, as well as a look at how the file structure of our docs works.
+Getting Set Up
+You need to have both python and pip set up on your machine to install MKDocs. You can find all the information for how to do that and what versions are required here. I had python already intalled on my machine, but needed to get pip:
+sudo easy_install pip
+sudo pip install mkdocs
+
+
+It seemed like using sudo
was important otherwise the mkdocs install failed with some nasty stack trace, but that may have been specific to my environment (Mac). Once you have got that all working and
+mkdocs --version
+returns an answer (currently mkdocs, version 0.16.1
), then you can clone into the status repo and get going.
+git clone https://github.com/status-im/wiki.status.im.git
+(or git clone git@github.com:status-im/wiki.status.im.git
if you have your SSH keys set up) followed by
+cd wiki.status.im
+mkdocs serve
+
+
+You should then be able to navigate to http://localhost:8000 or http://127.0.0.1:8000 and see the changes you are making to the wiki as you make them. Magic!
+General Notes on What We Look For
+Generally speaking, we like a lot of screenshots and less language as this helps us to guide people all over the world who may not all speak the same languages. Take a look at our User Guide for a rough outline of what we mean by balancing your text with screenshots and other helpful images.
+As you can see from our github repo all of the different documents are kept in the docs
directory. Click through to there to find the section and then the specific document you are wanting to add to or edit, or make a new file for documentation that you feel is missing.
+