readthedocs / readthedocs/ext-theme
Add a global error display for when JS fails
Open
Nobody has claimed this yet.
Accepted
Improvement
- Dominant language
- HTML
- Stars
- 12
- Forks
- 6
- Avg merge
- 13h 25m
- Merged PRs (30d)
- 1
Description
Add some top level error catch and display an error to the user if our JS fails. Otherwise, things just spin forever or silently fail and the user doesn't have much of an idea what happened.
- Catch exceptions and add a toast element to explain to the user that there was an error
Contributor guide
No contributing guide indexed for this repository
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
The issue names no files, entry points, or tests. Start by locating the top-level JavaScript entry point and the existing user notification or toast implementation, then determine how to exercise a JavaScript failure. Done means exceptions are caught and the user sees a clear error instead of an indefinite spinner or silent failure.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend, web-dev
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100