Skip to content

Feature Request: Support for Other C-Level Diagrams #1117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Pankraz76 opened this issue Mar 20, 2025 · 2 comments
Open

Feature Request: Support for Other C-Level Diagrams #1117

Pankraz76 opened this issue Mar 20, 2025 · 2 comments
Assignees
Labels
in: documentation support Documentation generation meta: waiting for feedback Waiting for feedback of the original reporter

Comments

@Pankraz76
Copy link

Pankraz76 commented Mar 20, 2025

🚀 Feature Request: Support for Other C-Level Diagrams

❓ Is there a way to create the other C-Level diagrams as well?
✨ It's already pretty nifty working for the components, so putting the other code through the UML processor should be manageable, right?

🙌 I would highly appreciate this feature, as I have a JMolecules application running that uses the same code.
💡 That's why I'm posting it here!

🛠️ However, I currently have to manually apply the PlantUML diagram to generate the full class diagram, as seen here:
🔗 GitHub - Clean Architecture

📌 C4 Model Diagrams

@odrotbohm odrotbohm self-assigned this Mar 21, 2025
@odrotbohm odrotbohm added in: documentation support Documentation generation meta: waiting for feedback Waiting for feedback of the original reporter labels Mar 21, 2025
@odrotbohm
Copy link
Member

Can you elaborate which diagrams you think we should additionally create? As far as I can tell, a Spring Modulith application's code base does not contain the information necessary for higher-level diagrams. We're currently looking into ways to export the level 3 information in the form of the Structurizr DSL snippets. With that manually authored model elements eventually ending up in context and container diagrams could be enriched with the information extracted from the code base.

@Pankraz76
Copy link
Author

Pankraz76 commented Mar 21, 2025

Of course, every diagram would be a big benefit to be generated as living documentation. The components are already achieved; the code should be quite simple—just pouring the package infos into PlantUML (PUML), just like it's done with the components in my assumption, and that should do the trick.

I would expect something like the existing writeModulesAsPlantUml—a corresponding writeClassesAsPlantUml as well—to be configurable.
writeModulesAsPlantUml Reference

How the higher-tier diagrams can be achieved is not within my competence.

  1. System Context Diagram
  2. Container Diagram
  3. Component Diagram
  4. Code Diagram

Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: documentation support Documentation generation meta: waiting for feedback Waiting for feedback of the original reporter
Projects
None yet
Development

No branches or pull requests

2 participants