Idea: add diagram generating tools
Open
Nobody has claimed this yet.
documentation
enhancement
good first issue
priority-low
- Dominant language
- TypeScript
- Stars
- 153
- Forks
- 46
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 7
Description
We should try existing tools like depcruiser, which work quite fine in my experience. The diagram generation can then be part of the build and visualizations can be deployed to gh-pages
Originally posted by @angelo-v in https://github.com/solid/solid-ui/issues/377#issuecomment-765959434
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No source file, test, or entry point is named. Start by evaluating dependency-cruiser and how diagram generation could fit into the build, then define how the visualizations would be deployed to gh-pages. Done should mean the scope, build integration, and publishing workflow are specified and implemented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, typescript
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100