withastro / withastro/docs

Clarify what errors are catchable

Open
#12,172 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

improve or update documentation
Dominant language
MDX
Stars
1.7k
Forks
1.9k
Avg merge
1d 12h
Merged PRs (30d)
97

Description

📚 Subject area/topic

Error handling

📋 Page(s) affected (or suggested, for new content)
📋 Description of content that is out-of-date or incorrect

Follows https://github.com/withastro/astro/issues/12383

prop for any error thrown during rendering

Quoting @Fryuni:

I'd say that sentence is actually the opposite of the technical truth 😅
It happens for every error except those that happen during rendering, since those are on an ongoing stream.
But what is calling the literal renderComponent function and what users might think as rendering might not be the same

🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)

No response

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 Error section on the Astro Pages documentation page and review the related issue #12383 for the technical context. Check whether the middleware page also needs error-handling guidance. Done means the documentation accurately explains which errors can be caught and avoids implying that errors during an ongoing render stream are handled the same way.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.