typelevel / typelevel/cats

A new version of cats-infographic is created

Open
#4,374 13 comments 0 reactions 1 assignee View on GitHub

@ShapelessCat is already working on this.

Since Jan 17, 2025.

  • #4325 by @tsobako — closed without merging
Dominant language
Scala
Stars
5.5k
Forks
1.2k
Avg merge
2d 10h
Merged PRs (30d)
5

Description

I see the cats document https://typelevel.org/cats/typeclasses.html refers tpolecat/cats-infographic, which is outdated and no maintenance since 2018-09-10.

I have created a new version of cats-infographic: https://github.com/ShapelessCat/cats-infographic/tree/develop. I do this for two reasons:

  • Address the outdated and no maintenance issue.

  • The original tpolecat/cats-infographic created its diagram with OmniGraffle, which generates .graffle files. OmniGraffle is not free. I replicate @tpolecat's work with LaTeX, and update my version to describe the type class hierarchy of cats 2.9.0, cats-effect 3.4.4, and cats-mtl 1.3.0.

I think the core contributors and maintainers of cats can consider to replace the old version cats-infographic with my new version. However, since I'm not an experienced LaTeX user, I think my diagram is not fancy enough in some details, including the fonts. I hope people can help me to polish my work, and then https://typelevel.org/cats/typeclasses.html can use it. I created the diagram with https://www.mathcha.io/. People who want to contributes can load the cats-infographic.mathcha file with https://www.mathcha.io/, and edit the diagram directly. After editing people can generate .pdf with https://www.overleaf.com/.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.