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

feat: document new entrypoints #9680

Merged
merged 3 commits into from
Oct 15, 2024
Merged

feat: document new entrypoints #9680

merged 3 commits into from
Oct 15, 2024

Conversation

ematipico
Copy link
Member

Description (required)

This PR documents a new upcoming feature for Astro v5, where the entrypoints of some functions can now accept URL other than a string

For Astro version: 5.0.0. See astro PR #12226.

@ematipico ematipico added improve documentation Enhance existing documentation (e.g. add an example, improve description) 5.0.0-beta labels Oct 15, 2024
Copy link

netlify bot commented Oct 15, 2024

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 8f3c758
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/670eafe38c43d600082be846
😎 Deploy Preview https://deploy-preview-9680--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@sarah11918 sarah11918 added the merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) label Oct 15, 2024
@ArmandPhilippot
Copy link
Contributor

@sarah11918 I think there is only one example where Added in: was in the middle of the section. I finally found it, it was next(). Chris and I found this a little strange, so what we decided was:

  • Write the type including the changes under the title
  • Do not add Since
  • Write in full "Since Astro v...," at the beginning of the sentence introducing the new type/parameter.

So I guess we could do the same thing here to be consistent? On the other hand these are two pages that have not yet been updated with the API format.

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.

Thanks for looking into this @ArmandPhilippot , and yes, I noticed that these don't seem to be updated in general for our new API reference. So, I would say especially for beta docs, we can merge as-is, and then look at updating these two pages eventually to match our format. Merging then changing is less chaotic when these pages aren't being immediately translated underneath us. 😄

@ematipico , I'm just making all the wording consistent, then this one is fine to merge for the beta release!

src/content/docs/en/reference/integrations-reference.mdx Outdated Show resolved Hide resolved
src/content/docs/en/reference/integrations-reference.mdx Outdated Show resolved Hide resolved
@ematipico ematipico merged commit e984433 into 5.0.0-beta Oct 15, 2024
5 checks passed
@ematipico ematipico deleted the feat/entrypoints-url branch October 15, 2024 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5.0.0-beta improve documentation Enhance existing documentation (e.g. add an example, improve description) merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants