-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation for unknown errors #6285
Conversation
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @Princesseuh, great work tackling this. I have a small suggestion and then LGTM!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, nice job!
@@ -676,7 +734,7 @@ See https://docs.astro.build/en/guides/server-side-rendering/ for more informati | |||
hint: 'See https://docs.astro.build/en/guides/content-collections/ for more on the `slug` field.', | |||
}, | |||
|
|||
// Generic catch-all | |||
// Generic catch-all - Only use this in extreme cases, like if there was a cosmic ray bit flip |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
😆 Nice clarification
Co-authored-by: Yan Thomas <61414485+Yan-Thomas@users.noreply.github.com>
* feat(errors): Add documentation for unknown errors * docs(errors): Misc refactors * docs(errors): Remove unnecessary messages * docs(errors): Add guidance around UnknownError * Update packages/astro/src/core/errors/errors-data.ts Co-authored-by: Yan Thomas <61414485+Yan-Thomas@users.noreply.github.com> --------- Co-authored-by: Yan Thomas <61414485+Yan-Thomas@users.noreply.github.com>
Changes
We still generate docs links for unknown errors, so we should have documentation for them!
Testing
N/A
Docs
It's docs all the way down!
/cc @withastro/maintainers-docs for feedback!