facebook / facebook/lexical

Feature: Error Handling Documentation

Open
#5,309 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
23.9k
Forks
2.2k
Avg merge
1d 16h
Merged PRs (30d)
61

Description

### Issue

The documentation lacks explanations on the types of errors one can expect, & methods to convey the errors to the users of an editor.

### Solution
The documentation should have a section that describes:
* Error types
* How to handle errors in code
* Suggestions on how to convey the error in the UI

Contributor guide

Open the contributing guide

Research direction

Start by locating the project's documentation structure and existing guidance on errors. Add a section covering error types, handling errors in code, and UI suggestions for conveying errors; the work is done when all three requested topics are documented clearly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.