search

DevStoriesAfrica / DevStories-app

A community app built using Kotlin, MVVM and Jetpack Libraries.
https://devstoriesafrica.com/
MIT License
29 stars 19 forks source link

Documentation of the app #27

Closed kibettheophilus closed 2 years ago

AkshaiBaruah commented 2 years ago

Can I work on this issue

Arthur-Kamau commented 2 years ago

From the readme I can see supported by gitbooks, am assuming that's the documentation method to be used. @kibettheophilus am I wrong?

kibettheophilus commented 2 years ago

@Arthur-Kamau that's right, you are not wrong.

Arthur-Kamau commented 2 years ago

For teams, it's a paid service or one should set up a personal account write the docs. Also, the docs could go into their own repo (assuming the docs will cover both the app and the backend).

kibettheophilus commented 2 years ago

They offered a teams account for us.

What do you mean by it can go to their own repo?

Arthur-Kamau commented 2 years ago

I thought since in the future there is going to be a backend that will also need documentation and even probably a web front end.There could be one documentation to cover everything(hence not under this github repository) In gitbook there is the option to back up the documentation in a github repository,a new repository could be created to host all the documentation.

kibettheophilus commented 2 years ago

Sure, that'll be a good way to do this.I will then close this issue and we'll use the other option.Thanks for sharing this.

Arthur-Kamau commented 2 years ago

Welcome.