typelevel / typelevel/cats

Very old scaladoc on typelevel.org

Open
#4,369 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

The cats website now points you to javadoc.io for accessing the scaladoc. However you can also still access https://typelevel.org/cats/api/cats/index.html which gives you all the docs for some very old version. That page is also the second search result that google gives me for cats scaladoc.

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

Start by checking the Cats website configuration and the old https://typelevel.org/cats/api/cats/index.html path, then compare it with the current javadoc.io destination. Determine how the stale documentation is being served and make the old search result no longer present outdated docs while keeping the current documentation link working.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.