Skip to content
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

[Feature] Integrating Architecture Diagram Visualization #13

Open
dugengmaster opened this issue Nov 30, 2024 · 1 comment
Open

[Feature] Integrating Architecture Diagram Visualization #13

dugengmaster opened this issue Nov 30, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request suggestion Give a suggestion to new feature UX User experience

Comments

@dugengmaster
Copy link

Feature Request: Add "Read Code => Architecture Diagram" Feature with Excalidraw Plugin

Is your feature request related to a problem? Please describe.
Currently, CodeBRT lacks a built-in feature to visualize code architecture. This makes it challenging for developers to quickly understand the structure and relationships within a codebase. As a result, onboarding new contributors or reviewing code can be time-consuming and error-prone.

Describe the solution you'd like
Integrate a feature that allows users to generate architecture diagrams by analyzing the code. The diagrams should visually represent the relationships and dependencies between different components, classes, or modules in the codebase.

This feature should:

  1. Use Excalidraw as a plugin to provide an interactive and customizable diagramming interface.
  2. Allow users to edit and refine the auto-generated diagrams for better clarity.
  3. Save or export the diagrams in a format that can be shared or stored in the repository.

Describe alternatives you've considered

  • Manual Diagram Creation: Developers can manually create diagrams using tools like Lucidchart, Visio, or Excalidraw directly, but this is time-intensive and not automated.
  • Other Visualization Tools: Tools like Graphviz or PlantUML could also be used, but they may not offer the same level of interactivity and ease of use as Excalidraw.

Additional context

  • The architecture diagram should support modular codebases and display hierarchical relationships where applicable.
  • This feature would benefit open-source contributors, code reviewers, and new developers onboarding onto the project.
  • Example integration of Excalidraw: Provide an embedded canvas in the UI where the diagram is displayed and editable.
@whats2000 whats2000 changed the title Future Issues: Integrating Architecture Diagram Visualization [Diagram] Integrating Architecture Diagram Visualization Nov 30, 2024
@whats2000 whats2000 added enhancement New feature or request suggestion Give a suggestion to new feature UX User experience labels Nov 30, 2024
@whats2000 whats2000 added this to the UX Development milestone Nov 30, 2024
@whats2000 whats2000 self-assigned this Nov 30, 2024
@whats2000
Copy link
Owner

I will start working on it soon!

@whats2000 whats2000 changed the title [Diagram] Integrating Architecture Diagram Visualization [Feature] Integrating Architecture Diagram Visualization Nov 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request suggestion Give a suggestion to new feature UX User experience
Projects
Development

No branches or pull requests

2 participants