Documentation Request: Readme and Contribution Guideline

cubos / sdkgen

[ DEPRECATED, SEE https://github.com/sdkgen/sdkgen ] Tool that aims on solving client-server communication and data layout sharing between server, web, android and ios using a description language also called sdkgen.

MIT License

45 stars 9 forks source link

Documentation Request: Readme and Contribution Guideline #9

Open eowfenth opened 6 years ago

eowfenth commented 6 years ago

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 commented 6 years ago

A list of supported platforms like that:

java_android
swift_ios
typescript_nodeserver
typescript_nodeclient
typescript_servertest
typescript_web

dygufa commented 6 years ago

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 commented 6 years ago

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

dygufa commented 6 years ago

After some research I narrowed down to two options:

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