Skip to content

Conversation

@ArmandPhilippot
Copy link
Member

@ArmandPhilippot ArmandPhilippot commented Dec 17, 2025

Description (required)

In integrations-reference.mdx:

  • Reorganizes the "Integration types reference" section
    • consistent headings (some used "type reference" but not all)
    • add a list of available type imports to be consistent with the other reference pages
    • moves IntegrationRouteData in a "Deprecated type imports" section
  • Adds RedirectConfig type
  • Adds RoutePart type
  • Adds RouteType type
  • Adds RouteData type
  • Adds ValidRedirectStatus type
  • Shaves IntegrationResolvedRoute and IntegrationRouteData now we have RouteData documented. 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 corresponding RouteData property.

In adapter-reference.mdx:

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:

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

/* Integrations imports */
import type {
  AssetsPrefix,
  AstroIntegrationMiddleware,
  AstroMiddlewareInstance,
  AstroRenderer,
  ClientDirective,
  ClientDirectiveConfig,
  RefreshContentOptions,
  ResolvedSessionConfig,
  RouteOptions,
  SSRComponentMetadata,
  SSRLoadedRenderer,
  SSRManifest,
} from "astro";

/* Either Integrations API or Dev toolbar imports */
import type {
  DevToolbarApp,
  DevToolbarAppEntry,
  DevToolbarMetadata,
  ResolvedDevToolbarApp,
  ToolbarServerHelpers,
} from "astro";

// `SerializedSSRManifest` is not exported, might be an issue.

Related issues & labels (optional)

@ArmandPhilippot ArmandPhilippot added improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. labels Dec 17, 2025
@netlify
Copy link

netlify bot commented Dec 17, 2025

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 87b7fe2
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/694430fbd055f3000762e017
😎 Deploy Preview https://deploy-preview-12946--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@astrobot-houston
Copy link
Contributor

astrobot-houston commented Dec 17, 2025

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/v5.mdx Source changed, localizations will be marked as outdated.
en/reference/adapter-reference.mdx Source changed, localizations will be marked as outdated.
en/reference/integrations-reference.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.

Copy link
Member

@florian-lefebvre florian-lefebvre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks pretty good!

Copy link
Member

@sarah11918 sarah11918 left a 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!

Copy link
Member

@sarah11918 sarah11918 left a 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!

@ArmandPhilippot ArmandPhilippot merged commit f507cb6 into withastro:main Dec 18, 2025
10 checks passed
@ArmandPhilippot ArmandPhilippot deleted the fix/adapter-integration-apis-types branch December 18, 2025 16:58
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Dec 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Adapter API links to a deprecated type

4 participants