Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: overview of the application logic #2139

Merged
merged 7 commits into from
Jun 11, 2024
Merged

Docs: overview of the application logic #2139

merged 7 commits into from
Jun 11, 2024

Conversation

thekaveman
Copy link
Member

@thekaveman thekaveman commented Jun 5, 2024

Based on some recent discussion and onboarding new team members, this page provides a high-level overview of all of the main phases through which the user is taken by the app.

Preview page: https://benefits-2139--cal-itp-previews.netlify.app/development/application-logic/

@thekaveman thekaveman requested a review from a team as a code owner June 5, 2024 21:32
@github-actions github-actions bot added the documentation [auto] Improvements or additions to documentation label Jun 5, 2024
Copy link

github-actions bot commented Jun 5, 2024

Coverage report

This PR does not seem to contain any modification to coverable code.

Copy link

github-actions bot commented Jun 5, 2024

@thekaveman thekaveman self-assigned this Jun 5, 2024
@thekaveman thekaveman marked this pull request as draft June 6, 2024 06:24
Copy link
Member

@lalver1 lalver1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great! 👍 I think the Entrypoint and Key supporting files call-outs work well to link the descriptions in the documentation with the code. The last diagram in the Enrollment section is also very useful given the different tokens used in this phase.
I only added one minor suggested change.

docs/development/application-logic.md Outdated Show resolved Hide resolved
@thekaveman thekaveman force-pushed the docs/app-logic branch 2 times, most recently from 18a0fba to 448c7b0 Compare June 11, 2024 01:46
@thekaveman thekaveman marked this pull request as ready for review June 11, 2024 01:54
@thekaveman thekaveman requested a review from lalver1 June 11, 2024 01:54
@thekaveman
Copy link
Member Author

Thanks for the suggestion @lalver1, I added that in.

I also added to each of the diagrams a block for the interaction with analytics, it's helpful to see when the key events are generated in each phase.

@lalver1
Copy link
Member

lalver1 commented Jun 11, 2024

I agree, adding the interaction with analytics made the diagrams even more useful yet they still look clear.

Copy link
Member

@lalver1 lalver1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 👍

Copy link
Member

@angela-tran angela-tran left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great! I really like the diagrams.

@thekaveman thekaveman merged commit bcda49e into dev Jun 11, 2024
14 checks passed
@thekaveman thekaveman deleted the docs/app-logic branch June 11, 2024 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation [auto] Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants