Add more documentation

[ObaraEmmanuel]

There's currently very limited documentation; I am but one man. It would be really great if someone would be as kind as to help in extending the existing docs. The best place to start is by writing examples. Below are some pointers on how to go about this:

1. Clone the repo and install the requirements for building the documentation by running the following command in the root directory

   pip install -r docs/requirements.txt
   

2. 🎓 Learn how to write documentation in restructured text and building with sphinx
3. 🖊️ Write up a step by step guide on how to build a simple app of your choosing using the studio. I have managed to write one so far and you can refer to it here .
4. Focus on one or more concepts of the studio, preferably those that have not been covered by previous examples.
5. Capture small precise screenshots at every step where necessary to keep the doc size small
6. ⚒️ Build the documentation by running the following command inside the docs/ directory

   make html
   

7. Make sure there are no errors, preview the docs in a browser (the html index after building will be at docs/_build/html/index.html). Iron out typos.
8. 🎊 Open a pull request and we will guide you from there

While you do all this, remember to have fun.

[PaulEcomaker]

Hi Emmanuel,
I've created an example for Formation Studio, and have it (locally) all set in GIT Desktop, but I cannot upload it to your repository.
As I am quite new to GIT, can you please help me here?
Thanks,
regards,
Paul

[ObaraEmmanuel]

Hi @PaulEcomaker, sorry for the late reply. To contribute to the project you will need to fork the repo and push the changes you have made to your own fork. From there you can create a pull request to this repository. You can find more details on how tot do this here. If you run into any issues let me know.

[PaulEcomaker]

Thanks @ObaraEmmanuel . I've created the "fork" and the pull request. Please review.