Skip to content

Conversation

@matthewp
Copy link
Contributor

Description (required)

Updates the v6 guide with breaking changes from the Environment API refactor

Related issues & labels (optional)

For Astro version: 6.x. See astro PR #14306.

@netlify
Copy link

netlify bot commented Nov 28, 2025

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 5efead1
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/6931e0a662eba40008d138f6
😎 Deploy Preview https://deploy-preview-12809--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 Nov 28, 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/v6.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

@ArmandPhilippot ArmandPhilippot left a comment

Choose a reason for hiding this comment

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

Thanks Matthew, this looks great. I left a few suggestions, mostly about headings/code snippet consistency.

My main concern is the "RouteData.generate() Removed" section. I don't think we document RouteData directly, but I can see it used in the Integrations page to transmit properties. Looking at the implementation PR, it seems generate() still exist under another format. So, maybe this is the change we want to document here? (but maybe I'm wrong, the implementation PR contains a lot of changes, I haven't checked all the details yet 😅 )

Also, while I was quickly looking at the implementation PR, I noticed we have two new properties for setAdapter(): we'll need to document them in the Adapter API guide under Building an adapter. We now have a subheading for each available prop, so we'll need to add devEntrypoint and entryType there.

matthewp and others added 5 commits November 29, 2025 12:09
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
@sarah11918
Copy link
Member

I just added a commit to reorganize and start to put these in our format.

  • These still need full editing and tracing through to docs to make sure all changes are reflected in regular v6 docs!
  • I have left some code comments in items for further work

@sarah11918 sarah11918 added the 6.0 label Dec 1, 2025
@matthewp
Copy link
Contributor Author

matthewp commented Dec 2, 2025

@sarah11918 to understand what is next, it looks like you've made the changes from the comment yourself. Is there anything remaining for me to do? I need to find places in the regular docs related to these changes and update those? Anything else?

@sarah11918
Copy link
Member

@matthewp I hope it's not too inconvenient, since I needed to move things around it was easier for me to make a single commit. I normally prefer leaving suggestions, but that wouldn't have been efficient here!

What you can do:

  • review the entries (that are moved) and make sure they are still accurate/correct, and/or make any editing suggestions you like!

What I will do with @ArmandPhilippot :

  • trace through each of these entries to look to see how they affect docs
  • leave comments where we might need guidance on updating the rest of the docs

@sarah11918 sarah11918 added this to the v6.0.0 docs milestone Dec 2, 2025
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.

OK, left a note on each individual entry with either "docs don't need updating" confirmation, or the things for @matthewp to look at current docs to see if updates are necessary there (and/or questions for @ArmandPhilippot to help get that done!)

So current Matthew tasks are:

  • review each individual entry as written here for the upgrade guide and make any suggestions needed
  • address each of these following 7 comments (you can resolve the ones that say no docs changes needed!) so we know we're aligning docs with these updates

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.

OK, I think I am happy with the upgrade guide content, and I've updated the Integration API reference page to remove mention of target.

There are two Future Team Docs documentation challenges (SerializedSSRManifest and RouteData/IntegrationResolvedRoute that we can consider.

Currently, on line 1052 of the Integration API page (edited in this PR, but just out of view of the changes), there is a link to specific lines in source code. It would be great to confirm that those lines are the same even on the next branch after this refactor? But worst case, we can figure that out later when revisiting SerializedSSRManifest. Updated, thank you Armand!

@sarah11918
Copy link
Member

Will wait for checks and Netlify so I can check the deploy preview visually, but otherwise, I think the content here seems fine now!

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.

@matthewp , @ArmandPhilippot - this has my blessing if everything is acceptable to y'all!

Copy link
Member

@ArmandPhilippot ArmandPhilippot left a comment

Choose a reason for hiding this comment

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

I left a small nit, but this LGTM! 🎉

Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Copy link
Member

@yanthomasdev yanthomasdev left a comment

Choose a reason for hiding this comment

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

A few nits from me and then LGTM

sarah11918 and others added 2 commits December 4, 2025 15:12
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
@sarah11918
Copy link
Member

This is so exciting!! I know the Environment API refactors have been a massive effort from the entire core framework team. I hope we've done y'all justice in docs, and will merge this into the v6 branch. There's lots of time before v6 if anyone spots anything in the upgrade guide after the fact, but let's all enjoy this being DONE!

@sarah11918 sarah11918 merged commit 09df252 into v6 Dec 4, 2025
10 checks passed
@sarah11918 sarah11918 deleted the v6-env branch December 4, 2025 19:39
@matthewp
Copy link
Contributor Author

matthewp commented Dec 4, 2025

Thanks @sarah11918 !

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants