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 JSDoc comments for error overlay to match other experimental flags #5633

Merged
merged 1 commit into from
Dec 19, 2022

Conversation

delucis
Copy link
Member

@delucis delucis commented Dec 18, 2022

Changes

Add configuration docs for the experimental.errorOverlay flag to match those for prerender and contentCollections.

Currently in docs we render out those other flags but not the errorOverlay flag: https://docs.astro.build/en/reference/configuration-reference/#experimental-flags

Testing

n/a docs change only

Docs

Yes. Is there a reason we wouldn’t want to document this like we do other experimental features?

@delucis delucis requested a review from a team as a code owner December 18, 2022 15:11
@changeset-bot
Copy link

changeset-bot bot commented Dec 18, 2022

⚠️ No Changeset found

Latest commit: 4d8a942

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

@delucis delucis self-assigned this Dec 18, 2022
@github-actions github-actions bot added the pkg: astro Related to the core `astro` package (scope) label Dec 18, 2022
Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving the text on behalf of Docs Maintainers!

@bluwy bluwy merged commit 7f7450e into main Dec 19, 2022
@bluwy bluwy deleted the chris/error-overlay-docs branch December 19, 2022 03:13
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.

None yet

3 participants