-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Add docs for RouteData in Integration API reference
#12946
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 docs for RouteData in Integration API reference
#12946
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
|
florian-lefebvre
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.
Looks pretty good!
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.
This looks fantastic, @ArmandPhilippot ! Just a couple of small comments from me, but when you're happy, I'm happy!
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.
This looks fantastic, @ArmandPhilippot ! Just a couple of small comments from me, but when you're happy, I'm happy!
Co-authored-by: Sarah Rainsberger <[email protected]>
Description (required)
In
integrations-reference.mdx:IntegrationRouteDatain a "Deprecated type imports" sectionRedirectConfigtypeRouteParttypeRouteTypetypeRouteDatatypedistUrl: this was added earlier, but the signature has changed in refactor(next): sendIntegrationRouteDatato integrations astro#11864fallbackRoutes: added in fix(i18n): review fallback system astro#9119origin: added in feat(next): astro:routes:resolved astro#12329ValidRedirectStatustypeIntegrationResolvedRouteandIntegrationRouteDatanow we haveRouteDatadocumented. Some description are still "duplicated" because the properties are remapped. I wasn't sure whether to keep the description or simply add a link to the correspondingRouteDataproperty.In
adapter-reference.mdx:IntegrationRouteDatalink in Adapter API withRouteData(fixes Adapter API links to a deprecated type #12789)routeDatadescription (more info below)Reading that sentence doesn't make sense to me:
integrationRouteData(lowercase) doesn't exist anywhere... So, I checked the changes to that line in the Git history:app.render()and so the description refers to the currentrouteDataproperty!I think the link was meant to be updated because of the deprecation, but not
routeData! Still, the description is a bit confusing (and that's probably why we ended up updating the property name associated with the link...). So I tried to reword that, and I moved the link to the type.Room for improvements: we have a lot of types targeting the source code instead of proper docs. Because there are a lot of them, it's probably better to do that in another PR and keep this one focused on fixing the docs issue.
List of undocumented types related or at least used in the Integration API reference
I haven't checked these types yet. Maybe some don't really need docs and we could flatten the type instead. And maybe some depends on other types not in that list...
Related issues & labels (optional)