[Documentation] We need a page that explains what data types in the library are
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 2.5k
- Forks
- 636
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 7
Description
Currently the doc pages don't have something that lists what Stream and the related types are. I'm not looking for javadoc - somethings that explains at a higher level, without being a tutorial, and with minimal jargon (so that people newer to FP/scala can pick up the gist). We can have 1-2 usage examples as well.
Specifically we should cover:
- Stream
- Chunk
- Pull (lesser priority since it's more advanced)
I think the style that cats-effect uses for its data types fits fairly well here, or something in readthedocs.io style - something people can easily index into or search for/through
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 by reviewing the existing FS2 documentation and the cats-effect data-type pages referenced in the issue, then identify the documentation entry point for Stream, Chunk, and, at lower priority, Pull. Done means a searchable, high-level page with minimal jargon and 1–2 usage examples covering the requested types.
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
- 45/100