Update prefetch docs with browser support information by bluwy · Pull Request #8246 · withastro/docs

bluwy · 2024-05-10T10:17:49Z

Description (required)

Update the prefetch docs based on the core PR linked below, which includes some internal behaviour changes.

I also added a new browser support section to explain the behaviour difference between browsers, and how to ensure prefetching works reliably.

Related issues & labels (optional)

For next Astro patch. See astro PR withastro/astro#10999 (not a minor)

vercel · 2024-05-10T10:17:52Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 15, 2024 3:15pm

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
docs-i18n	⬜️ Ignored (Inspect)			May 15, 2024 3:15pm

bluwy · 2024-05-10T10:18:47Z

src/content/docs/en/guides/prefetch.mdx


 - If a visitor is using [data saver mode](https://developer.mozilla.org/en-US/docs/Web/API/NetworkInformation/saveData) or has a [slow connection](https://developer.mozilla.org/en-US/docs/Web/API/NetworkInformation/effectiveType), prefetch will fallback to the `tap` strategy.
 - Quickly hovering or scrolling over links will not prefetch them.
- Links that use the `viewport` or `load` strategy are prefetched with a lower priority to avoid clogging up the network.


This will no longer be the case as all strategies will internally use <link rel="prefetch"> which has the same (low) priority.

bluwy · 2024-05-10T10:19:14Z

src/content/docs/en/guides/prefetch.mdx

-You can additionally configure the priority of prefetching by passing the `with` option:
-
-```js
-// Prefetch with `fetch()`, which has a higher priority.
-prefetch('/about', { with: 'fetch' });
-
-// Prefetch with `<link rel="prefetch">`, which has a lower priority
-// and manually scheduled by the browser. (default)
-prefetch('/about', { with: 'link' });
-```


The with option is deprecated so I removed this to discourage people from using it.

astrobot-houston · 2024-05-10T10:20:29Z

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

Locale	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.

sarah11918

Looks great, @bluwy !

I tried something different with the browser support section (haven't seen it in preview yet, so it might be awful). Let's see what we think!

src/content/docs/en/guides/prefetch.mdx

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

bluwy · 2024-05-14T15:34:39Z

Thanks! I like your suggested formatting too. I committed them and view locally and it looks like this:

Screenshot (Vercel link should also be possible)

Seeing this, maybe we could remove the Support: prefix on each paragraphs? Since the heading "Browser support" already implies so.

sarah11918 · 2024-05-14T15:59:36Z

Yup, agreed! I had it in my head that maybe the different original list items were going to be different, repeatable "things"... but nope, I think without will be just fine!

nit: just seeing now: in the Safari one, there's no comma between "fetch() API which"

bluwy · 2024-05-15T08:08:12Z

Thanks! I've updated and removed them now.

bluwy · 2024-05-15T14:44:22Z

@sarah11918 the core PR has been released. Waiting on your approval just in case and I think we can then merge this

sarah11918 · 2024-05-15T14:58:17Z

@bluwy Thanks, taking one more final pass now, then I'll merge!

src/content/docs/en/guides/prefetch.mdx

sarah11918

Thank you, @bluwy , LGTM!

Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com>

* i18n(fr): Update guides/astro-db from #8478 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/backend from #8450 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/backend/google-firebase from #8422 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/cms/apostrophecms from #8480 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/cms/builderio from #8259 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/cms/directus from #8647 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/cms/ghost from #8518 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/cms/statamic from #7119 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/content-collections from #8447 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/data-fetching from #8210 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/deploy/cloudflare from #8421 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/deploy/netlify from #8233 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/deploy/render from #8233 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/deploy/vercel from #8217 (and fix little typos) Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/environment-variables from #8533 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/environment-variables from #8611 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/images from #8447 #8646 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/integrations-guide from #8575 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/integrations-guide/cloudflare from #8211 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/integrations-guide/lit from #8270 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/integrations-guide/markdoc from #8167 (Steeeeps) Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/integrations-guide/preact from #8644 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/integrations-guide/react from #8038 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/integrations-guide/vue from #8295 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/markdown-content from #7218 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/markdown-content from #8167 #8239 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/middleware from #8572 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/prefetch from #8246 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/routing from #8466 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/rss from #8632 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/testing from #8369 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update guides/view-transitions from #8646 Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Fix typo in routing.mdx Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Fix links ? Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Fix badge Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Fix badge Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Fix tabs Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Fix tabs Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * Update src/content/docs/fr/guides/environment-variables.mdx Co-authored-by: pioupia <49518790+pioupia@users.noreply.github.com> * Update src/content/docs/fr/guides/integrations-guide/lit.mdx Co-authored-by: pioupia <49518790+pioupia@users.noreply.github.com> * Update src/content/docs/fr/guides/integrations-guide/vue.mdx Co-authored-by: pioupia <49518790+pioupia@users.noreply.github.com> * Update src/content/docs/fr/guides/markdown-content.mdx Co-authored-by: pioupia <49518790+pioupia@users.noreply.github.com> * Update src/content/docs/fr/guides/middleware.mdx Co-authored-by: pioupia <49518790+pioupia@users.noreply.github.com> * Update src/content/docs/fr/guides/testing.mdx Co-authored-by: pioupia <49518790+pioupia@users.noreply.github.com> * Update src/content/docs/fr/guides/testing.mdx Co-authored-by: pioupia <49518790+pioupia@users.noreply.github.com> * Update src/content/docs/fr/guides/testing.mdx Co-authored-by: pioupia <49518790+pioupia@users.noreply.github.com> * i18n(fr): Fix links Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): Update `tutorial/6-islands` because CI links err Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): fix links Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> * i18n(fr): fix links Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> --------- Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com> Co-authored-by: pioupia <49518790+pioupia@users.noreply.github.com> Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>

Update prefetch docs with browser support information

1d5181f

bluwy added the add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. label May 10, 2024

bluwy mentioned this pull request May 10, 2024

Improve prefetch behaviour for browsers withastro/astro#10999

Merged

bluwy commented May 10, 2024

View reviewed changes

vercel bot deployed to Preview – docs May 10, 2024 10:21 View deployment

sarah11918 reviewed May 14, 2024

View reviewed changes

sarah11918 added the merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) label May 14, 2024

Apply suggestions from code review

36a0588

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

vercel bot deployed to Preview – docs May 14, 2024 15:36 View deployment

bluwy added 2 commits May 15, 2024 16:07

Update docs

f9bfc0a

Merge branch 'main' into prefetch-docs-update

e04fef1

vercel bot deployed to Preview – docs May 15, 2024 08:23 View deployment

sarah11918 reviewed May 15, 2024

View reviewed changes

src/content/docs/en/guides/prefetch.mdx Outdated Show resolved Hide resolved

replacing "should"

247a580

sarah11918 approved these changes May 15, 2024

View reviewed changes

Merge branch 'main' into prefetch-docs-update

a1fe157

sarah11918 added the Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! label May 15, 2024

sarah11918 merged commit 30a4314 into main May 15, 2024

sarah11918 deleted the prefetch-docs-update branch May 15, 2024 15:15

vercel bot deployed to Preview – docs May 15, 2024 15:15 View deployment

huyikai mentioned this pull request May 16, 2024

i18n(zh-cn): Update prefetch.mdx #8288

Merged

jsparkdev mentioned this pull request May 17, 2024

i18n(ko-KR): update prefetch.mdx #8308

Merged

thomasbnt added a commit to thomasbnt/docs that referenced this pull request Jun 25, 2024

i18n(fr): Update guides/prefetch from withastro#8246

8976b53

Signed-off-by: Thomas Bonnet <thomasbnt@protonmail.com>

thomasbnt mentioned this pull request Jun 25, 2024

i18n(fr): Update all Guides files in French language (june 25) #8673

Merged

Uh oh!

Conversation

bluwy commented May 10, 2024

Description (required)

Related issues & labels (optional)

For next Astro patch. See astro PR withastro/astro#10999 (not a minor)

Uh oh!

vercel bot commented May 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bluwy May 10, 2024

Choose a reason for hiding this comment

Uh oh!

bluwy May 10, 2024

Choose a reason for hiding this comment

Uh oh!

astrobot-houston commented May 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Lunaria Status Overview

Tracked Files

Uh oh!

sarah11918 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bluwy commented May 14, 2024

Uh oh!

sarah11918 commented May 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bluwy commented May 15, 2024

Uh oh!

bluwy commented May 15, 2024

Uh oh!

sarah11918 commented May 15, 2024

Uh oh!

Uh oh!

sarah11918 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vercel bot commented May 10, 2024 •

edited

Loading

astrobot-houston commented May 10, 2024 •

edited

Loading

sarah11918 commented May 14, 2024 •

edited

Loading