Add a documentation page on error handling
Open
Nobody has claimed this yet.
documentation
help wanted
- Dominant language
- Scala
- Stars
- 5.5k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 5
Description
There's some major gaps around error handling in the official docs, especially painful because the whole ecosystem relies on them - library users are often instructed to use MonadError/ApplicativeError error handling code, but it's not present in the documentation
- Add a page on ApplicativeError/MonadError (one page, likely)
- Either on that page or on its own page, provide a "cookbook" of common error handling examples
This is mentioned in #1801, but I thought it was worth calling out as its own issue
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
No files or tests are identified in the issue. Start by reviewing the official documentation structure and existing references to ApplicativeError and MonadError. Done means adding a page covering both typeclasses and a cookbook of common error-handling examples, either on that page or a separate one.
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
- Mostly clear
- Newbie friendliness
- 35/100