Give more visibility to the documentation
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 5.5k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 5
Description
I think the cats documentation is a bit hard to reach from the README, this is the expected path to SemigroupK:
- Land on https://github.com/typelevel/cats
- → click Documentation#website link
- → click Typeclasses
- → scroll down
- → click SemigroupK
As an example, I find it way more accessible on scalajs-react or scalacss :
- Land on https://github.com/japgolly/scalajs-react
- → click Router
My suggestion would be to give it more visibility on the README, for instance by adding a big pile of links like the following:
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 repository README and compare its current documentation path with the linked Cats website and SemigroupK page. Make the documentation easier to discover from the README, then verify that the added links reach the expected typeclass and data type pages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100