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 Request: Generate Architecture Diagrams from Specific Entry Points #5

Open
ofir5300 opened this issue Dec 5, 2024 · 1 comment
Labels
backlog Backlog of new features and enhancements enhancement New feature or request

Comments

@ofir5300
Copy link

ofir5300 commented Dec 5, 2024

Hey 👋

I propose enhancing swark to allow generating architecture diagrams from a specific source file or entry point instead of analyzing an entire folder. This feature would help users focus on particular flows and eliminate redundant dependencies, resulting in clearer and more relevant diagrams.

Benefits:
• Targeted Visualization: Focus on specific components or flows without unnecessary clutter.
• Simplified Diagrams: Reduce complexity by omitting unrelated dependencies.
• Enhanced Control: Users can specify exactly what to include in the architecture diagram.

Proposed Solution:
• Entry Point Specification: Provide a way for users to specify a single source file or entry point when generating the architecture diagram.
• Selective Analysis: Modify the generation logic to start from the specified entry point and exclude unrelated dependencies.
• UI Integration: If applicable, add a feature in the GUI to select an entry point for diagram generation.

Example Use Case:
A developer working on a specific feature can generate an architecture diagram for that feature alone, avoiding the distraction of unrelated modules and dependencies.

Thank you for considering this enhancement. It will make swark more flexible and user-friendly by allowing more precise architecture visualizations.

@ozanani
Copy link
Member

ozanani commented Dec 15, 2024

Thank you for this great suggestion @ofir5300 !
The use case totally make sense.
The implementation will require a different file retrieval algorithm than what we have today and iteratively prompting the LLM to figure out what files to provide next.
Putting this on Swark's backlog 👍🏻

@ozanani ozanani added enhancement New feature or request backlog Backlog of new features and enhancements labels Dec 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog Backlog of new features and enhancements enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants