Skip to content

docs: fix outdated astro:assets imports and snippets - #14478

Closed
Nloperena wants to merge 1 commit into
withastro:mainfrom
Nloperena:cursor/fix-astro-assets-docs-14281-779e
Closed

docs: fix outdated astro:assets imports and snippets#14478
Nloperena wants to merge 1 commit into
withastro:mainfrom
Nloperena:cursor/fix-astro-assets-docs-14281-779e

Conversation

@Nloperena

Copy link
Copy Markdown

Description (required)

Docs-only fix for outdated astro:assets imports and an incorrect <Image /> snippet, matching the current public API.

English only.

References

- Remove deprecated image utilities from astro/assets/utils docs:
  - matchHostname, matchPathname, matchPort, matchProtocol (removed in astro#16197)
  - emitImageMetadata (removed in astro#14306)
- Move propsToFilename and hashTransform docs from astro/assets/utils to astro/assets (moved in astro#15435)
- Move ImageTransform.background docs from Image component to ImageTransform type where it actually exists
- Fix v6 upgrade guide to not recommend using the removed emitImageMetadata function

Fixes withastro#14281

Co-authored-by: Nicholas M Loperena <Nloperena@users.noreply.github.com>
@astrobot-houston

Copy link
Copy Markdown
Contributor

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/upgrade-to/v6.mdx Source changed, localizations will be marked as outdated.
en/reference/modules/astro-assets.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
Copy Markdown
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.

@ArmandPhilippot

Copy link
Copy Markdown
Member

Thanks, but AI generated PR are not helpful. If you read the issue, you'll see we are trying to figure out what is the best course of action here. Nothing has been decided yet. So, I'm closing this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Incorrect snippet and outdated imports in astro:assets docs

4 participants