droidconKE2020App icon indicating copy to clipboard operation
droidconKE2020App copied to clipboard

documentation

Open tamzi opened this issue 4 years ago • 14 comments

Do we need better documentation with everything for the app?

tamzi avatar Jan 25 '20 13:01 tamzi

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

JabezNzomo99 avatar Jan 25 '20 20:01 JabezNzomo99

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 avatar Jan 26 '20 05:01 jamesnyakush

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

jamesnyakush avatar Jan 26 '20 06:01 jamesnyakush

Yes in full support of this

wangerekaharun avatar Jan 26 '20 08:01 wangerekaharun

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.

ghost avatar Jan 28 '20 06:01 ghost

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

jamesnyakush avatar Jan 28 '20 07:01 jamesnyakush

thsi seems like it will be a continous process

tamzi avatar Feb 14 '20 16:02 tamzi

Yes this issue remains open

wangerekaharun avatar Feb 14 '20 16:02 wangerekaharun

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

odaridavid avatar Feb 15 '20 16:02 odaridavid

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

Yes its Work In Progress

wangerekaharun avatar Feb 17 '20 14:02 wangerekaharun

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

TheAlchemistKE avatar Mar 24 '20 12:03 TheAlchemistKE

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

wangerekaharun avatar May 12 '20 20:05 wangerekaharun

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

TheAlchemistKE avatar May 12 '20 22:05 TheAlchemistKE

@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.

wangerekaharun avatar May 13 '20 09:05 wangerekaharun