ZORALab / Hestia

One Peaceful Frontend+Backend Software Library Suite.
https://hestia.zoralab.com
Other
19 stars 1 forks source link

Update Project Documentation with More Why (Too Much How) #32

Closed hollowaykeanho closed 1 year ago

hollowaykeanho commented 1 year ago

Description

Please provide a short description of what you have encountered below.

Thanks to Sibert's feedback, the document has to be updated with more business reasons + evidence + why use it. Too much how at the moment.

Suggested inspiration:

  1. Looking into Cake recipes (present the "end in mind" first, then speaks how.

Link

Please provide the documentation link(s) below.

N/A

Expected Presentation

Please specify the expected presentation of the documentation.

Document is comprehensible even for those aspiring folks.

Current Presentation

Please specify the current presentation of the documentation.

Document is too complex and flooded with too much how. No idea why it matters to people.

Attachment

Please drag and drop the necessary data files (e.g. screenshot, logs, etc)
below.
hollowaykeanho commented 1 year ago

Applied in f9426ce058c1fad3f9d61eb6dcade1fb9b44beb1

hollowaykeanho commented 1 year ago

Sibert confirmed that we're on the right track so mark this ticket as done first. Split the rest of the new feedbacks as separate tickets.

hollowaykeanho commented 1 year ago

Released in https://github.com/ZORALab/Hestia/releases/tag/v1.0.0