API AutoFlow Documentations
Contribution Guide

This documentation is written by API AutoFlow users for API AutoFlow users.
Feel free to make updates. Your proposed changes will be reviewed before being published.

View the Documentations

How to make documentation updates

You can either make update directly from the Github website or clone the repository to make changes on your desktop.

All changes are reviewed and edited by the editors before being published.

Updating using Github website

All the pages are located in the docs folder

1. Select the file you wish to update
2. Press the Edit button to open the editor
3. Press Propose Changes button after filling out the title and details
4. Open a Pull request
5. Fill out the title and details of the Pull Request (It can be the same as the Propose changes request)

Design and development principles of this document:

1. Explain like you would to someone who doesn't know anything about the topic
2. Don't assume knowledge of the reader. Give explanations (or link) when additional concepts are mentioned. Don't leave areas where the read may get stuck from your explanation.
3. Embrace revisions

Remember, the goal of documentations is to help users who don't know about API AutoFlow find the information they need to successfully build their solution.

jekyll serve

bundle exec jekyll serve