Transitions in docs
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 5.5k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 5
Description
I was just looking at http://typelevel.org/cats/typeclasses/applicativetraverse.html (which is really neat!), and it wasn't obvious to me that the series continues with Functor, Applicative, Traverse when I got to the end of the first page. I thought that it was just a work in progress. For these "series"-type docs, it may be good to have a link at the bottom of each page to the next item in the series.
I think it's a bit more obvious for the other sections, but the Applicative and Traversable Functors title is long enough that the text gets wrapped on the table of contents on the left side and threw me off a bit.
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 linked Applicative and Traversable Functors page and inspect the surrounding series pages and their documentation navigation. Add a link at the bottom of each relevant page to the next item in the series, then verify that the sequence is clear and the long title remains understandable in the table of contents.
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