Skip to content

Implement a Process for Keeping the User Flow in the README Updated #19

Open
@amalnanavati

Description

@amalnanavati

To make it as easy as possible for folks to visualize the app's functionality, it is important for the user flow in the README to be up-to-date. At the same time, everytime someone makes a change to the app, we don't want them to go through too much work recreating/modifying the user flow.

This issue encompasses coming up with a process (to be added to the required PR checklist) by which we can keep the user flow up-to-date. Ideas include:

  • Don't make the user flow super prescriptive on the app's UI, and instead focus on the functionality. That way, it doesn't have to be updated for every small UI change.
  • Create a soft copy of the doc and link it / embed it into the README. That way, it can be auto-updated in the readme. Something like this seems promising.
  • Identify the best tool to use to make and update the user flow. Google Drawing? Miro? Figma? etc.

Metadata

Metadata

Assignees

No one assigned

    Labels

    dev-processIssues related to continuous integration, dependencies, etc.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions