CodeForPhilly / CodeForPhilly/balancer-main

[Documentation] Update README Diagram with MermaidJS diagram

Open
#513 0 comments 0 reactions 0 assignees View on GitHub
Documentation
Dominant language
TypeScript
Stars
21
Forks
19
PR merge metrics
No merged PRs in 30d

Description

## Update README Diagram with MermaidJS Diagram

## Background
README diagrams are currently embedded as static image assets. Replacing them with Mermaid diagrams will make them easier to maintain, review, and update directly in Markdown. Mermaid diagrams also render natively on GitHub, reducing the need to manage separate image files and keeping documentation changes closer to the source.

## Existing Behavior

## Acceptance Criteria
- [ ] All README diagrams that can be represented in Mermaid are converted from image assets to Mermaid syntax.
- [ ] Existing diagram content and relationships are preserved or updated to the current repo status

## Approach

## References
- GitHub Mermaid documentation: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams
- Mermaid documentation: https://mermaid.js.org/

## Risks and Rollback

## Screenshots / Recordings

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.