Skip to content
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

Merged
merged 5 commits into from
Feb 17, 2023
Merged

Conversation

Princesseuh
Copy link
Member

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!

@Princesseuh Princesseuh requested a review from a team as a code owner February 17, 2023 17:25
@changeset-bot
Copy link

changeset-bot bot commented Feb 17, 2023

⚠️ No Changeset found

Latest commit: e298c36

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added the pkg: astro Related to the core `astro` package (scope) label Feb 17, 2023
@Princesseuh Princesseuh self-assigned this Feb 17, 2023
Copy link
Member

@yanthomasdev yanthomasdev left a 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!

packages/astro/src/core/errors/errors-data.ts Outdated Show resolved Hide resolved
Copy link
Member

@natemoo-re natemoo-re left a 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
Copy link
Member

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>
@Princesseuh Princesseuh merged commit a857727 into main Feb 17, 2023
@Princesseuh Princesseuh deleted the feat/unknown-errors-data branch February 17, 2023 19:31
liruifengv pushed a commit to liruifengv/astro that referenced this pull request Feb 18, 2023
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: astro Related to the core `astro` package (scope)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants