search

tianhaoz95 / acumany-re

Building a world where all experiences are valued.
http://tianhaoz.com/acumany-re
MIT License
0 stars 0 forks source link

Initialize design docs for top-level decisions #2

Closed tianhaoz95 closed 4 years ago

tianhaoz95 commented 4 years ago

This pull request adds a barebone skeleton of Tech stack and UI/UX design docs along with several TODOs to populate the design docs.

This is to have a record of the design choices to guide development.

Also, this pull request adds CODEOWNER for better code management and automatic pull request merging for design docs.

todo[bot] commented 4 years ago

Rename the product

Come up with a name that is better than Acumany before launch.

https://github.com/tianhaoz95/acumany-re/blob/d1f6aa7f0c89a4821062114a8783769b051f86a2/README.md#L4-L8

This comment was generated by todo based on a todo comment in d1f6aa7f0c89a4821062114a8783769b051f86a2 in #2. cc @tianhaoz95.
todo[bot] commented 4 years ago

Add details for tech stack

After the tech stack is decided, add details here for new developers to get started.

https://github.com/tianhaoz95/acumany-re/blob/d1f6aa7f0c89a4821062114a8783769b051f86a2/docs/README.md#L12-L17

This comment was generated by todo based on a todo comment in d1f6aa7f0c89a4821062114a8783769b051f86a2 in #2. cc @tianhaoz95.
todo[bot] commented 4 years ago

Add getting started guide

After the tech stack infra is done, add instructions for new developers to get started.

https://github.com/tianhaoz95/acumany-re/blob/d1f6aa7f0c89a4821062114a8783769b051f86a2/docs/README.md#L21-L26

This comment was generated by todo based on a todo comment in d1f6aa7f0c89a4821062114a8783769b051f86a2 in #2. cc @tianhaoz95.
todo[bot] commented 4 years ago

Platform preference

Decide if we should go with mobile first or web first.

https://github.com/tianhaoz95/acumany-re/blob/d1f6aa7f0c89a4821062114a8783769b051f86a2/docs/design-docs/tech-stack-study.md#L8-L13

This comment was generated by todo based on a todo comment in d1f6aa7f0c89a4821062114a8783769b051f86a2 in #2. cc @tianhaoz95.
todo[bot] commented 4 years ago

Choose service vendor

List our needs and avaiable frameworks, and choose the one that fits our needs.

https://github.com/tianhaoz95/acumany-re/blob/d1f6aa7f0c89a4821062114a8783769b051f86a2/docs/design-docs/tech-stack-study.md#L15-L20

This comment was generated by todo based on a todo comment in d1f6aa7f0c89a4821062114a8783769b051f86a2 in #2. cc @tianhaoz95.
todo[bot] commented 4 years ago

Choose app framework

List our needs and avaiable frameworks, and choose the one that fits our needs.

https://github.com/tianhaoz95/acumany-re/blob/d1f6aa7f0c89a4821062114a8783769b051f86a2/docs/design-docs/tech-stack-study.md#L22-L27

This comment was generated by todo based on a todo comment in d1f6aa7f0c89a4821062114a8783769b051f86a2 in #2. cc @tianhaoz95.
todo[bot] commented 4 years ago

Choose server framework

List our needs and avaiable frameworks, and choose the one that fits our needs.

https://github.com/tianhaoz95/acumany-re/blob/d1f6aa7f0c89a4821062114a8783769b051f86a2/docs/design-docs/tech-stack-study.md#L29-L34

This comment was generated by todo based on a todo comment in d1f6aa7f0c89a4821062114a8783769b051f86a2 in #2. cc @tianhaoz95.
todo[bot] commented 4 years ago

Choose app server interface schema

List our needs and avaiable app server interface schema, and choose the one that fits our needs.

https://github.com/tianhaoz95/acumany-re/blob/d1f6aa7f0c89a4821062114a8783769b051f86a2/docs/design-docs/tech-stack-study.md#L36-L38

This comment was generated by todo based on a todo comment in d1f6aa7f0c89a4821062114a8783769b051f86a2 in #2. cc @tianhaoz95.
todo[bot] commented 4 years ago

Add mockups

Add a few mockups to guide the design of technical stack

https://github.com/tianhaoz95/acumany-re/blob/d1f6aa7f0c89a4821062114a8783769b051f86a2/docs/design-docs/ui-ux-study.md#L4-L6

This comment was generated by todo based on a todo comment in d1f6aa7f0c89a4821062114a8783769b051f86a2 in #2. cc @tianhaoz95.
ninjatron commented 4 years ago

Reviewed and approved.