docs: Add Mermaid diagrams to document system processes#31
docs: Add Mermaid diagrams to document system processes#31pniedzwiedzinski wants to merge 2 commits intomasterfrom
Conversation
Added Mermaid diagrams to README.md mapping out User Creation, Requests Cleanup, and Cyclic Account Deactivation. Used sequenceDiagram and flowchart TD with English descriptions. Co-authored-by: pniedzwiedzinski <19212948+pniedzwiedzinski@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
Added Mermaid diagrams to README.md documenting User Creation, Requests Cleanup, and Cyclic Account Deactivation. Based on feedback, used high-level actors (Applicant/User, Superior, Admin) instead of technical components to ensure maximum readability for non-technical users. Emphasized the revalidation flow forwarding mechanism. Co-authored-by: pniedzwiedzinski <19212948+pniedzwiedzinski@users.noreply.github.com>
1 participant
This PR adds Mermaid diagrams to the README documentation to clearly visualize the system's core processes.
formHandler,httpHandler,editHandler) using a sequence diagram.freshCleanup,cleanupPendingRequests) using a flowchart.scheduleForDeactivation,oldCleanup) using a sequence diagram, highlighting the required user action for superior verification.PR created automatically by Jules for task 14648061015193427147 started by @pniedzwiedzinski