Skip to content

Refresh Architectural CL Big Picture - #1156

Draft
alexannekk wants to merge 6 commits into
netgroup-polito:masterfrom
alexannekk:bigpicture-new
Draft

Refresh Architectural CL Big Picture #1156
alexannekk wants to merge 6 commits into
netgroup-polito:masterfrom
alexannekk:bigpicture-new

Conversation

@alexannekk

@alexannekk alexannekk commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

This PR updates the introductory README by revising the high‑level architectural “big picture” to provide a clearer and an up-to-date overview of CrownLabs’ main components and their interactions. The new diagram aims to be easier to edit and better aligned with how newcomers approach the project.

The update adopts a graph‑as‑code approach using Mermaid for MarkDown syntax, replacing the previous static diagram with a modular, text‑based representation. This makes the architecture easier to evolve, simplifies future contributions, and ensures that small structural changes can be reflected quickly through minimal edits to the diagram’s source.

Co-authored-by: @QcFe

Closes #1157

Replaced image with a mermaid flowchart for CrownLabs architecture.
@alexannekk
alexannekk requested a review from a team as a code owner July 10, 2026 20:42
@kingmakerbot

Copy link
Copy Markdown
Collaborator

Hi @alexannekk. Thanks for your PR.

I am @kingmakerbot.
You can interact with me issuing a slash command in the first line of a comment.
Currently, I understand the following commands:

  • /rebase: Rebase this PR onto the master branch
  • /merge: Merge this PR into the master branch
  • /hold: Adds hold label to prevent merging with /merge
  • /unhold: Removes the hold label to allow merging with /merge
  • /deploy-staging: Deploy a staging environment to test this PR (the build-all flag enables user environments building)
  • /undeploy-staging: Manually undeploy the staging environment

Make sure this PR appears in the CrownLabs changelog, adding one of the following labels:

  • kind/breaking: 💥 Breaking Change
  • kind/feature: 🚀 New Feature
  • kind/bug: 🐛 Bug Fix
  • kind/cleanup: 🧹 Code Refactoring
  • kind/docs: 📝 Documentation

@alexannekk
alexannekk marked this pull request as draft July 10, 2026 20:42
@alexannekk
alexannekk force-pushed the bigpicture-new branch 3 times, most recently from c9615e6 to 6bc7972 Compare July 15, 2026 17:51
@alexannekk alexannekk added the kind/docs Improvements or additions to documentation label Jul 21, 2026
@alexannekk

Copy link
Copy Markdown
Contributor Author

@QcFe adopting the strategy in point 2 or 3 described in the issue #1044 may resolve (at least partially) the problem of linking the graph each other with mermaid

- edited graphs with backticks and improved formatting
- divided diagram into multiple logical focuses
- added missing main elements
- Updated naming to be self-explanatory
@alexannekk
alexannekk force-pushed the bigpicture-new branch 2 times, most recently from 4344bb4 to a1c00eb Compare July 30, 2026 00:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/docs Improvements or additions to documentation sig/community size/L

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update Architectural Big Picture in Introductory README

2 participants