docs: add data-model and auth-flow diagrams and handoff notes - #229
Merged
Conversation
kevinrutledge
force-pushed
the
docs/add-data-model-and-auth-diagrams
branch
from
June 10, 2026 05:00
d8e17fa to
f12b7be
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Developer
Kevin Rutledge
What changed?
The architecture doc had three flowcharts but no data-model or auth diagram, and the repo-access handoff was undocumented. This adds two Mermaid diagrams and folds a handoff section into the future-work doc.
docs/figures/data-model.mmd+.png- an ER diagram of the 12 Prisma models and their relationsdocs/figures/auth-flow.mmd+.png- a sequence diagram of the portal -> callback -> 303 -> cookie -> DAL login flowdocs/architecture.md- embed both diagrams, with a note on why the callback uses 303 over 307docs/future-work.md- add "Repository access and handoff" (how the next team gets repo admin via an org owner / leads team) and "Remaining co-op handoff items" (referral-tab link, Blob store, test row)How to test
docs/architecture.mdand confirm the ER diagram renders under Data Model and the sequence diagram under Token Authentication.docs/future-work.mdand confirm the two handoff sections at the end.npx -y @mermaid-js/mermaid-cli -i docs/figures/data-model.mmd -o docs/figures/data-model.png -b white.Checklist