typelevel / typelevel/sbt-typelevel
Migrate plugins DOT diagram to Mermaid
Open
Nobody has claimed this yet.
docs
good first issue
- Dominant language
- Scala
- Stars
- 185
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
Laika now supports mermaid, so we can integrate the diagram into the site more directly. This will make it easier to edit and keep up-to-date without requiring to commit a rendered SVG.
Contributor guide
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
Start with docs/plugins.dot and review how the site currently renders or includes that diagram. Check Laika's Mermaid support and identify the documentation entry point that should use it instead of a committed rendered SVG. Done means the plugins diagram is integrated into the site as Mermaid and remains editable without the SVG.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100