typelevel / typelevel/cats

Style scaladoc slightly

Open
#1,835 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I have a bunch of Scaladocs for different projects open for reference, but they all look identical, so I get lost sometimes. Something simple like using Typelevel red rather than the default blue would totally solve this.

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

No files or tests are identified. Start by locating the Scaladoc generation and styling configuration in the Cats repository, then inspect a rendered Scaladoc page and determine where the default blue theme is defined. Done means the generated Scaladocs use the requested Typelevel red styling consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.