Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more documentation #8

Open
ObaraEmmanuel opened this issue Jun 4, 2021 · 0 comments
Open

Add more documentation #8

ObaraEmmanuel opened this issue Jun 4, 2021 · 0 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@ObaraEmmanuel
Copy link
Owner

ObaraEmmanuel commented Jun 4, 2021

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.

@ObaraEmmanuel ObaraEmmanuel added help wanted Extra attention is needed good first issue Good for newcomers labels Jun 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant