Tanzania-AI-Community / twiga

Twiga is a WhatsApp bot for Tanzanian educators.
https://ai.or.tz/
MIT License
6 stars 5 forks source link

[Feature]:Write documentation in english to describe the code architecture #5

Open jurmy24 opened 1 month ago

jurmy24 commented 1 month ago

Is your feature request related to a problem? Please describe. It might be difficult for new contributors to understand the codebase.

Describe the solution you'd like There should be a docs/en/ folder with an ARCHITECTURE.md file that describes the project architecture as of right now. In addition, the CONTRIBUTING.md file could be put in there too and updated with more details on how to contribute. Some of the code within CONTRIBUTING.md could probably be moved to a separate file called something like GETTING_STARTED.md. You could even have a separate file with more screenshots and stuff but that may be better just in the README.

Describe alternatives you've considered Nope

Additional context Nope