The current architectural “big picture” in the main README is outdated and does not fully represent the present structure of CrownLabs. The existing diagram is static, difficult to update, and lacks modularity, making it harder for contributors to understand the system at a glance.
What needs to be done
- Refresh the high-level architecture diagram in the introductory README.
- Provide a clearer overview of the main components and their interactions.
- Replace the static image with a text-based, maintainable diagram.
How to address it
- Adopt a graph-as-code approach using Mermaid.
- Introduce a modular diagram that can be easily extended or modified.
- Ensure the new diagram aligns with the current architecture and onboarding needs.
Linked PR: #1156
The current architectural “big picture” in the main README is outdated and does not fully represent the present structure of CrownLabs. The existing diagram is static, difficult to update, and lacks modularity, making it harder for contributors to understand the system at a glance.
What needs to be done
How to address it
Linked PR: #1156