typelevel / typelevel/cats-effect

Improve "Concurrency Basics" documentation

Open
#319 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

:books: docs :gear: infrastructure
Dominant language
Scala
Stars
2.2k
Forks
576
Avg merge
2d 11h
Merged PRs (30d)
18

Description

#287 is merged and published here

I don't want to stop there, I'm happy to improve and expand it incrementally but it needs a place to gather more feedback. If there is a lot of it we could even make a todo list and complete it together.

@rossabaker has mentioned that he already has few ideas. :)

todo-list

  • continuations
  • stack safety

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 with the published Concurrency Basics page linked in the issue and review its current coverage. Use the listed TODO items—continuations and stack safety—as the initial scope; done means the documentation is expanded and additional feedback or follow-up work is captured.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.