Update Cloudflare imageService docs for custom image service support - #14095
Conversation
Clarify that `compile` mode uses a configured custom `image.service` when defined (running its `getURL()`/`getHTMLAttributes()` hooks during prerendering), and that `custom` mode now also generates optimized assets at build time via the service's `transform()` hook, without bundling Sharp when it is not needed. See withastro/astro#17099.
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
|
Hello! Thank you for opening your first PR to Astro’s Docs! 🎉 Here’s what will happen next:
|
|
Preview deployment ✅ Deployment complete!
|
ArmandPhilippot
left a comment
There was a problem hiding this comment.
Thank you, and welcome. Sorry for the delay, with v7 release, I didn't have the chance to review this sooner!
I don't know if this is because I'm not familiar enough with Cloudflare but the lengthy explanations from the two PRs confused me a bit. I hope I got it right. 😄 Feel free to double check the accuracy of my suggestions!
What bothers me currently is that some elements look like implementation details (so, not helpful for the user), and it isn't really clear what falls under pre-rendering versus on-demand rendering.
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
|
@ArmandPhilippot thanks for the feedback! Read it through a dozen times to make sure that the essence of the PR changes are captured and properly reflected in your suggestions and they are. Really appreciate it! |
ArmandPhilippot
left a comment
There was a problem hiding this comment.
Thank you for double checking, and the updates! This looks good to me (what, am I biased? 😄 ). We can always add "Sharp is not compatible" later if someone complains!
withastro#14095) Co-authored-by: Armand Philippot <git@armand.philippot.eu>
withastro#14095) Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Clarify that
compilemode uses a configured customimage.servicewhen defined (running itsgetURL()/getHTMLAttributes()hooks during prerendering), and thatcustommode now also generates optimized assets at build time via the service'stransform()hook, without bundling Sharp when it is not needed.See withastro/astro#17099.
Description (required)
Two mode descriptions were out of date:
compilepreviously always used the adapter's internal workerd image service. It now uses the configuredimage.serviceif one is defined (running its customgetURL()andgetHTMLAttributes()hooks while prerendering), and falls back to the internal dependencies only when no custom service is set.custompreviously ran only at runtime. It now also generates optimized image assets at build time for prerendered routes (the service'stransform()hook runs at build), and Sharp is no longer bundled into the worker when the configured service does not need it.The edits keep the existing bullet structure, reuse the existing Image Options link, and preserve the existing
workerdruntime caveat oncustom.Related issues & labels (optional)
compile+custom) astro#17099improve or update documentationDiscord username: adam.chal