-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
fix(astro:assets): add docs for missing imports and types #12867
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
fix(astro:assets): add docs for missing imports and types #12867
Conversation
✅ Deploy Preview for astro-docs-2 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
|
|
This should be ready to review now!
|
sarah11918
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, just a few comments here before we decide what to do about the table of contents!
This could mean showing fewer levels, I think this should include avoiding "Image properties" so we can just have the image component, then each property etc. and we might end up strategically hiding some of the "building an image service only" content.
We'll figure that out!
Co-authored-by: Sarah Rainsberger <[email protected]>
Co-authored-by: Sarah Rainsberger <[email protected]>
Co-authored-by: Sarah Rainsberger <[email protected]>
|
I believe we would need this because of the |
sarah11918
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Preview with the new h2 and h3 only looks good! Thanks for this amazing work, Armand!
Description (required)
astro/assets/utilsfrom the Image Service API toastro:assetsmodule because we're now documenting the slash versions alongside the virtual modules. No content has changed except the following:matchProtocol()description (default value)matchPort()astro:assets:getConfiguredImageService(): added in fix(assets): Fix types to be more accurate astro#6530imageConfig: added in fix: missing imageConfig type in astro:assets astro#8414astro:assetstypesLocalImagePropsRemoteImagePropsastro/assetsimports:baseServicegetConfiguredImageService(): same asastro:assetsgetImage(): because this is internal code we probably don't want to expose it? Maybe this should be theastro:assetsversion instead.isLocalService()astro/assetstypes (same asastro:assets)astrotypes related to assets (instead of listing them alphabetically, I tried to group them by usage)ImageInputFormatImageMetadata: added in fix(assets): Fix types to be more accurate astro#6530orientation: added in fix(assets): Fix images not following EXIF rotation astro#7637ImageOutputFormatImageQualityImageQualityPresetImageTransformdensitiesandwidths: added in feat(assets): Add support forsrcsetand a Picture component astro#8620fitandposition: added in feat: experimental responsive images astro#12377 Note that responsive images have been stabilized in feat: unflag responsive images astro#13917 but this doesn't updateImageTransform, so saying "since v5" is probably fine?UnresolvedImageTransformGetImageResultsrcSet: added in feat(assets): Add support forsrcsetand a Picture component astro#8620RemotePattern: exported in withastro/astro@6ee63bf / [ci] release astro#14466ImageServiceConfig: added in feat(image): Update image service config to allow passing settings to the service astro#6848ImageServiceExternalImageServiceLocalImageServiceGetImageResultcode snippet ingetImage()astro:assetsfrom the Image Service APIRelated issues & labels (optional)
add new content,improve or update documentation