Documentation

[HexF]

Currently README is the only documentation available regarding API endpoints, internals, configuration, and contribution.

To solve this issue, we should create comprehensive documentation detailing the workings of the system to make it easier for new contributors, or integrator to make use of Piston.

We could possibly use something like readthedocs or a GitHub Pages solution with Jekyll to complete this task, making it as simple as possible to modify and have a beautiful display for our docs.

cc @dthree

[HexF]

I made a small start in docs/, automatically publishing them at https://piston.readthedocs.io

Things to possibly add could be:

• [ ] Internal workings of the code base (the 3 components - api, cli & repo)
• [ ] Contributing guide and guidelines for the code and packages
• [ ] Documentation on the CLI
• [ ] Documentation on the CLI wrapper/management script (./piston)
• [ ] Documentation on pps files, and the custom image builder