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 eagerness option description and example for prefetch() #11250

Merged
merged 13 commits into from
Apr 1, 2025

Conversation

Marocco2
Copy link
Contributor

Description (required)

As per request, I've added a new section for Prefetch docs page describing what the new option does and a use case that it would be useful

For Astro version: 5.6. See astro PR #13405

Copy link

netlify bot commented Mar 18, 2025

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 657ba25
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/67ebe0adc1e781000842702b
😎 Deploy Preview https://deploy-preview-11250--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.

@astrobot-houston
Copy link
Contributor

astrobot-houston commented Mar 18, 2025

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/guides/prefetch.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@astrobot-houston
Copy link
Contributor

Hello! Thank you for opening your first PR to Astro’s Docs! 🎉

Here’s what will happen next:

  1. Our GitHub bots will run to check your changes.
    If they spot any broken links you will see some error messages on this PR.
    Don’t hesitate to ask any questions if you’re not sure what these mean!

  2. In a few minutes, you’ll be able to see a preview of your changes on Netlify 🥳.

  3. One or more of our maintainers will take a look and may ask you to make changes.
    We try to be responsive, but don’t worry if this takes a few days.

@sarah11918 sarah11918 added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah! labels Mar 18, 2025
@sarah11918 sarah11918 added this to the 5.6.0 milestone Mar 18, 2025
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.

Thank you for submitting the docs for this great new feature, @Marocco2 ! I'm sure people will really appreciate having this!

I just made some editing suggestions to make this sound more like the rest of our docs and follow some of our styles. You are the expert in this topic, so please correct anything that's wrong, and make any suggestions back if something needs fixing!

@Marocco2
Copy link
Contributor Author

Thank you for submitting the docs for this great new feature, @Marocco2 ! I'm sure people will really appreciate having this!

I just made some editing suggestions to make this sound more like the rest of our docs and follow some of our styles. You are the expert in this topic, so please correct anything that's wrong, and make any suggestions back if something needs fixing!

Thank you for taking your time making the changes! I found all of them reasonable, so I've merged them 👍

@sarah11918
Copy link
Member

Thank you! From now on, these docs should not change too much, but probably just typos etc. In that case, I will commit small fixes directly so that you do not have to be bothered. 😄

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, good work!

@sarah11918 sarah11918 added the Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! label Apr 1, 2025
@sarah11918 sarah11918 changed the base branch from main to 5.6.0 April 1, 2025 12:58
@sarah11918
Copy link
Member

Would love a final approval from @Marocco2 here, as I added some stuff, so make sure this all still seems correct!

@ArmandPhilippot , I added the API reference at the top so couldn't hurt for you to confirm. 😄

Then, I think this is ready to merge into the 5.6.0 PR branch for this week's release! 🥳

@Marocco2
Copy link
Contributor Author

Marocco2 commented Apr 1, 2025

Would love a final approval from @Marocco2 here, as I added some stuff, so make sure this all still seems correct!

@ArmandPhilippot , I added the API reference at the top so couldn't hurt for you to confirm. 😄

Then, I think this is ready to merge into the 5.6.0 PR branch for this week's release! 🥳

I've checked. All good 👍

Copy link
Member

@ArmandPhilippot ArmandPhilippot left a comment

Choose a reason for hiding this comment

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

@sarah11918 The API reference seems fine to me! However, I don't understand why, I can't see it in the preview (there is only Since):

API reference is missing under eagerness

Edit: I copied the changes locally to test, and this works fine with the dev server. So I guess it's just a bug in the preview?

@sarah11918
Copy link
Member

@ArmandPhilippot It's because previews aren't generated for PRs not to the main branch! (I forget sometimes myself.) We can double double check once it's merged into the 5.6.0 PR, because that is made to the main branch. I switched target branches earlier than usual, because we're ahead of the game, but I forgot (myself) that we lose previews that way.

@sarah11918 sarah11918 merged commit a9d57b2 into withastro:5.6.0 Apr 1, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants