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

Architecture Documentation for droidconKE 2023 app #3

Closed
tamzi opened this issue Feb 14, 2023 · 3 comments
Closed

Architecture Documentation for droidconKE 2023 app #3

tamzi opened this issue Feb 14, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@tamzi
Copy link

tamzi commented Feb 14, 2023

Is your feature request related to a problem? Please describe.
We need to have a proper architecture documentation that:

  • Shows what the app will look like and features it plugs into.
  • Lack of this documented vision and direction often causes confusion to the contributors.

Describe the solution you'd like

  • Create documentation before we start implementing features. Tools like Mockla or draw.io and a link to the diagram made open then linked to a docs section in the app.
  • Require documentation of features as they are developed(Inline + or - on the markdown.

Describe alternatives you've considered
No documentation is the alternative and its a painful experience.

Additional context
Previous calls for documentation have been ignored an explanation by code owners would be great. See this issue

@jumaallan
Copy link
Member

🤞

@tamzi tamzi added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 14, 2023
@chepsi
Copy link
Contributor

chepsi commented Feb 16, 2023

Changing the title to droidcon 2023

@chepsi chepsi changed the title Architecture Documentation for droidconKE 2022 app Architecture Documentation for droidconKE 2023 app Feb 16, 2023
@chepsi
Copy link
Contributor

chepsi commented Mar 25, 2024

Marking this as stale

@chepsi chepsi closed this as completed Mar 25, 2024
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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

6 participants