Documentation

[kxepal]

We need document what we have here. Currently all we have is reference to source code. That's geeky, but not user friendly. Documentation should cover at least the following topics:

• Quick start
• Contribution guide
• YAML schema definition
• Public API reference
• Troubleshooting

[kxepal]

Fixed via #23

[KostyaEsmukov]

Some topics are still not covered though. Quick start/Installation is definitely an important piece which is still missing.

[kxepal]

Ok, reopening to tracking missing bits. However, quick start / installation is in README and +/- actual.

[KostyaEsmukov]

Quick start

Not sure what should we put there. I tend to think that the "Installation" page from #28 would cover this.

Contribution guide

Still missing. There's a convention at GitHub to put such a guide in a CONTRIBUTING.md file (instead of RTD), so I suggest to follow it.

YAML schema definition

Done.

Public API reference

Done (sort of).

Troubleshooting

Still missing. Any idea what should be covered here?