amplify icon indicating copy to clipboard operation
amplify copied to clipboard

[Documentation] Add project description, roadmap, and table of contents to first section of README

Open therzka opened this issue 3 years ago • 7 comments

The README currently jumps right in to technical info. We should include a blurb about the project itself, where to learn more about the app and Program Equity, as well as links to other parts of the documentation. A roadmap diagram or description of the overall vision would also be useful.

The video from this discussion would be great to include: https://github.com/ProgramEquity/amplify/discussions/62#app

therzka avatar Oct 13 '22 20:10 therzka

I've written a project description but have a question about the roadmap. Would we want to display the user's journey through the application? Similar to the diagrams in issue #62? I was thinking of adding a gif in place of a diagram as a gif would safe space, and be more presentable to the user.

LoopFruits avatar Nov 09 '22 20:11 LoopFruits

@LoopFruits what do you think of a map like this? Screen Shot 2022-12-20 at 1 57 26 PM

To reproduce on mermaid.live

manishapriya94 avatar Dec 20 '22 22:12 manishapriya94

I would like to work on this portion of the README, I am just having troubles assign it to myself

Alex-is-Gonzalez avatar Feb 08 '23 22:02 Alex-is-Gonzalez

Is work complete on this particular issue?

Terieyenike avatar Mar 06 '23 17:03 Terieyenike

Is work complete on this particular issue?

@Terieyenike I think there are multiple parts to it, but they're mostly done. :) Do you think you can contribute more?

@therzka Should we close this issue?

paramsiddharth avatar Mar 08 '23 08:03 paramsiddharth

Branch: issue-356

Dunridge avatar Apr 11 '25 20:04 Dunridge

I just added the iteration in the branch issue-356, is the task complete?

Branch: issue-356

C-Icaro avatar Apr 12 '25 19:04 C-Icaro