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

docs: update security.checkOrigin JSDoc comment #12011

Merged

Conversation

ArmandPhilippot
Copy link
Contributor

Changes

The default value for security.checkOrigin has changed in v5, so I updated the JSDoc comment to:

  • fix the type of security (this is not a boolean if I make no mistake)
  • define its default value
  • add an example to show how to disable this behavior

Testing

N/A, it's doc.

Docs

This is a doc PR. I added a changeset, not sure if it was necessary since it is for v5 (first time I'm publishing to the next branch).
But a review from Team docs could be helpful!
/cc @withastro/maintainers-docs for feedback!

Copy link

changeset-bot bot commented Sep 16, 2024

🦋 Changeset detected

Latest commit: 3a49111

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

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

@github-actions github-actions bot added pkg: astro Related to the core `astro` package (scope) docs pr labels Sep 16, 2024
@matthewp matthewp merged commit cfdaab2 into withastro:next Sep 16, 2024
14 checks passed
@ArmandPhilippot ArmandPhilippot deleted the docs/config-security-checkorigin branch September 16, 2024 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs pr pkg: astro Related to the core `astro` package (scope)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants