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

Add documentation #239

Open
Goff-Davis opened this issue Apr 21, 2021 · 0 comments
Open

Add documentation #239

Goff-Davis opened this issue Apr 21, 2021 · 0 comments
Assignees
Labels
mobile todo Issue is not being worked on yet

Comments

@Goff-Davis
Copy link
Collaborator

Goff-Davis commented Apr 21, 2021

Architecture Documentation

An ARCHITECTURE.md file should be created. See here for a somewhat preachy explanation of what that is.

It should cover:

  • The flow of the mobile app, what pages there are, how are they connected
  • Explain each component and where it fits in to the system. Special attention should be paid to major components, so a button doesn't need much explanation, but the home component has more going on.
  • Anything else you think can help someone get an effective mental map of the mobile app.

Readme

Make sure the readme is up to date with all the latest environment variables, commands, and explanations on how to get started developing and deploying.

Commenting

Comments should be added to code that is complex or could be hard to understand. Don't do line by line or real nitty gritty stuff since that can change, but explain the reasoning behind a section, for example.

@Goff-Davis Goff-Davis added mobile todo Issue is not being worked on yet labels Apr 21, 2021
@kennygperez kennygperez self-assigned this Apr 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
mobile todo Issue is not being worked on yet
Projects
None yet
Development

No branches or pull requests

2 participants