General documentation

[akhila-raju]

Add documentation under the Github wiki.

Documentation should include:

• Setup and deployment models
• Query handbook (example queries)
• How to contribute (running tests, opening issues & PRs, etc)
• FAQ

What else should be added?

[raulk]

Overall this looks good to me!

I'd rename the "Setup and how to use" to "Setup and deployment models", to make it clear that ethql can be deployed in an number of ways (standalone, embedded, hosted on Infura).

"How to contribute" is super valuable.

An architecture/design section would be welcome (this one is on me!).

[raulk]

@akhila-raju could you break this down into a task list so we can track progress individually?

Would be great if you could start working on it ASAP.

For the contribution guide, you can take inspiration from popular Github repos. Have a look at "projects with the most contributors" and "most-forked projects" here: https://octoverse.github.com/.

Another valuable source is Apache projects (Apache Ignite has a well-structured process).

Here's another one: https://gist.github.com/PurpleBooth/b24679402957c63ec426

[akhila-raju]

Sure, I'll add a task list. Already started working on it 😊

[akhila-raju]

Query handbook is done, unless there are more that should be added! 😊