typelevel / typelevel/cats-effect
Fix indexed 2.x documentation links
Open
Nobody has claimed this yet.
:books: docs
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
The first result of https://www.google.com/search?q=IO+fromFuture (https://typelevel.org/cats-effect/datatypes/io.html for me) redirects to a broken page. Could the path structure of the new docs gracefully handle existing permalinks?
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 indexed https://typelevel.org/cats-effect/datatypes/io.html URL and compare it with the current documentation path structure. Check how the new docs handle existing permalinks and verify that the IO fromFuture search result resolves to the relevant documentation page. Done means the old link no longer redirects to a broken page.
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
- 35/100