docs: complete project documentation and implement gh pages

[yashlamba]

Issue for tracking documentation:

• [x] README and CONTRIBUTING
• [ ] SIMULATION IDEAS
• [x] ~~Try dartdoc~~ (Using MkDocs)
• [ ] #105
• [ ] Update Contributing Guide

[yash2189]

Can I take up the following Readme and contributing part?

[keshakaneria]

@yash2189 Are you continuing this documentation? so accordingly I'll help you or take up this issue?

[yash2189]

Yes I am continuing

[yashlamba]

Hi @keshakaneria and @yash2189, I have update the README and CONTRIBUTING, if you would like to start documenting the code, that would be great or have any suggestion for above, that too is welcome.

[himanshusharma89]

Hey, @yashlamba I would like to work with dartdoc documentation.

[yash2189]

Hey @yashlamba I'd like documenting the code as you mentioned above.

[yashlamba]

Sure, I haven't planned yet on how to do the documentation for the code but we can have a discussion over it. As far as dartdoc goes, I would be interested in seeing some basic implementation because I'm not sure I have seen many projects using it. If you implement it, I can have a look at your branch in the forked repo and then we can open sequential PRs so that (if contributing under GSSoC'20), you don't lose points for such an extensive task.

[yash2189]

Is there a slack channel for the the same, we can have a discussion over there if possible?

[yashlamba]

If you are contributing under GSSoC, you can join #proj_simulate otherwise you can join the gitter channel mentioned in the README:)