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:
- 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
- 🎓 Learn how to write documentation in restructured text and building with sphinx
- 🖊️ 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 .
- Focus on one or more concepts of the studio, preferably those that have not been covered by previous examples.
- Capture small precise screenshots at every step where necessary to keep the doc size small
- ⚒️ Build the documentation by running the following command inside the
docs/ directory
- 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.
- 🎊 Open a pull request and we will guide you from there
While you do all this, remember to have fun.
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:
docs/directorydocs/_build/html/index.html). Iron out typos.While you do all this, remember to have fun.