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

Automate diagram creation of all pages/components #14

Open
chartgerink opened this issue Dec 18, 2024 · 0 comments
Open

Automate diagram creation of all pages/components #14

chartgerink opened this issue Dec 18, 2024 · 0 comments

Comments

@chartgerink
Copy link
Member

In a project, it is easy for many pages and components to arise fairly quickly. It would be great to add a automated mermaid diagram, which highlights all the files and their imports.

This can help navigate the project structure, but also help to visually identify opportunities to simplify the codebase and harmonize components.

I imagine this going something like this:

  1. GitHub action reads all the .tsx files
  2. For every .tsx file
  3. identify the unique imports
  4. write out each unique import into a mermaid diagram with .tsx file as source
  5. save the diagram to the README (or another markdown file)

This is not urgent at the moment, but important for the project. 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant