Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation #4

Open
tamzi opened this issue Jan 25, 2020 · 14 comments
Open

documentation #4

tamzi opened this issue Jan 25, 2020 · 14 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@tamzi
Copy link
Contributor

tamzi commented Jan 25, 2020

Do we need better documentation with everything for the app?

@tamzi tamzi self-assigned this Jan 25, 2020
@JabezNzomo99
Copy link
Contributor

Yes, i think it would be great to have a detailed documentation of the architecture, technologies and flow of the app

@jamesnyakush
Copy link

It would be great so that in future after the events someone can refer to it and catch up what guys were really doing

@jamesnyakush
Copy link

I have realized that @wangerekaharun has a tendency of revisiting the code when he tries to explain i think we will be making his life easy so that people can get what he always says quickly and have a place to refer

@wangerekaharun
Copy link
Contributor

Yes in full support of this

@ghost
Copy link

ghost commented Jan 28, 2020

Also, the need for proper documentation is so that community members who want to learn, can read good code which can in turn help them write better code, understand how features were implemented and also act as a guide on how to properly document projects.

@jamesnyakush
Copy link

Great this is the only way forward just a suggestion we should write every bit like how modularization , Dependency injection was done like topic-based how safe API was handled and the likes

@tamzi tamzi added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 5, 2020
@tamzi
Copy link
Contributor Author

tamzi commented Feb 14, 2020

thsi seems like it will be a continous process

@wangerekaharun
Copy link
Contributor

Yes this issue remains open

@odaridavid
Copy link
Contributor

On the Readme,there seems to be duplication on references and could use slight grammatical and content formatting improvements.

@wangerekaharun
Copy link
Contributor

On the Readme,there seems to be duplication on references and could use slight grammatical and content formatting improvements.

Yes its Work In Progress

@TheAlchemistKE
Copy link

I would really love to help, can you please point me on the best place to start.

wangerekaharun pushed a commit that referenced this issue May 5, 2020
@wangerekaharun
Copy link
Contributor

@KelynPNjeri How would you like to help with this, sorry it's been long.

@TheAlchemistKE
Copy link

@wangerekaharun I am kind of a beginner. So what tasks would you recommend?

@wangerekaharun
Copy link
Contributor

@wangerekaharun I am kind of a beginner. So what tasks would you recommend?

I would recommend you first take time to go through the project and familiarize yourself first then you can be in a better position to pick up a task once its raised. Or even you could find something that we are missing out and help in fixing it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

6 participants