As a maintainer I should document the design and functionality of the overall application

[thescientist13]

Type of Change

• New Feature Request
• Documentation
• Improvement / Suggestion
• Bug
• Other (please clarify below)

Summary

To move out of a POC phase, formal features and designs should be made, to best plan out the development.

One important UX consideration I can think of will be handling long lists, so pagination strategies and / or lazy loading strategies will be required, as well as potential text searching capabilities.

Details

Topics to cover:

1. Topology / API - How the data is managed, setup, etc
2. Technical Architecture - server(less), API gateway, S3, etc. the infrastructure and data organization
3. Release Management - Release process and workflows
4. Designs: What the app should look like (this ticket)
5. Functional Specification: What the app should do
6. Onboarding Guide