typelevel / typelevel/cats-effect
Update site diagrams to use mermaid
Open
Nobody has claimed this yet.
:books: docs
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
https://typelevel.org/cats-effect/docs/core/io-local and
https://typelevel.org/cats-effect/docs/std/supervisor (once the site redeploys) both include diagrams. Can we render these diagrams more nicely with mermaid?
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 the documentation pages at /docs/core/io-local and /docs/std/supervisor and locate the diagram source used on each page. Replace those diagrams with Mermaid-rendered versions, then verify both pages after the site redeploys and confirm the diagrams display correctly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100