OpenSourceFellows / amplify

Open Source Fellow Sandbox
https://amplify-app-production.herokuapp.com/
MIT License
83 stars 60 forks source link

Audit the Wiki Pages Describing Features #502

Open rsensenig opened 1 year ago

rsensenig commented 1 year ago

In response to documentation issue #357, I updated the wiki so that the features from this Dev discussion are nested under "Features" on the sidebar of the wiki with a page dedicated to each feature.

I've also created labels named after the features, which can be seen here: https://github.com/ProgramEquity/amplify/labels.

The Feature pages that I added need to be reviewed to ensure that the information is fully up-to-date, since the content I moved from the Devs discussion thread is a little old now. For example, the graphics used to illustrate the user journey mentions "Google Civic API" instead of "Cicero API," which is the API now used for legislative district matching (this also needs to be updated in the graphics used in App Structure and App Logic in the wiki).

Labels should also be added to Open Issues that align with the different Features. The search for the label can then be linked at the bottom of the corresponding Feature page. An example can be seen here at the bottom of the "Authenticate" page: https://github.com/ProgramEquity/amplify/wiki/Authenticate. This will aid with the onboarding of future fellows.

paramsiddharth commented 1 year ago

@rsensenig Great job, Rachel! :) Well done on pointing out the potential usage of labels to connect issues and documentation topics.

kazvee commented 10 months ago

I've updated the below pages and graphics to reference "Cicero API" currently being used for legislative district matching, and removed references to the previous "Google Civic API":