typelevel / typelevel/cats

Type class infographic on its own page

Open
#2,224 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Scala
Stars
5.5k
Forks
1.2k
Avg merge
2d 10h
Merged PRs (30d)
5

Description

Per my tweet, I think it would be nice to have the cats-infographic svg on its own page rather than on https://typelevel.org/cats/typeclasses.html, which is getting to be quite a large page.

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.

Research direction

Open the current typeclasses.html page and the linked cats-infographic SVG first. Move the infographic to its own documentation page while keeping the existing page usable and check that the SVG renders correctly from the new location.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.