Documentation Request: Readme and Contribution Guideline

[eowfenth]

We need to start our documentation in the repository, I thought about:

• Contribution Guidelines
• Code of Conduct
• Read me, containing how to run the project, software dependencies and use cases.

You guys think that we need more topics? If yes, which ones?

[edgardleal]

A list of supported platforms like that:

• java_android
• swift_ios
• typescript_nodeserver
• typescript_nodeclient
• typescript_servertest
• typescript_web

[dygufa]

I will deploy a documentation website in this repo with instructions about how to run the projects and targets available as well until next week. Do you guys have any specific "documentation template generator" in mind?

[edgardleal]

I think this can help: https://mistic100.github.io/jekyll-bootstrap-doc/

[dygufa]

After some research I narrowed down to two options:

• https://github.com/facebook/docusaurus
• https://github.com/QingWei-Li/docsify/

And I have decided to use docusaurus, in the next few days I will deploy the first draft.