docs: fix some mistakes in Environment API guides#20000
Merged
patak-cat merged 9 commits intovitejs:mainfrom May 30, 2025
Merged
docs: fix some mistakes in Environment API guides#20000patak-cat merged 9 commits intovitejs:mainfrom
patak-cat merged 9 commits intovitejs:mainfrom
Conversation
patak-cat
reviewed
May 5, 2025
patak-cat
reviewed
May 5, 2025
patak-cat
reviewed
May 5, 2025
patak-cat
reviewed
May 5, 2025
Contributor
Author
|
Wow, I sure did suck at this 😆 Thanks for being so constructive about it, though, and let me know if there's anything else. |
Member
|
Oh, no problem! It is good to see where you are finding difficulties in the docs. I'll let others check the PR to see if they would like to change the environment names as you proposed. To be honest, I'm fine with the names we had (except for the typo you corrected with |
sapphi-red
reviewed
May 7, 2025
patak-cat
approved these changes
May 30, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
I love the Environment API. Here are a few important fixes to the guides to help people when trying it out:
nodeenvironment toserverremove the usage of the non-existentvite-environment-providerpackageenvironment), and specific in others (ssrEnvironment), so I made them all specific, which I believe is good practice anywaythere is advice thatssrenvironment can be calledserveras well, which is arguably misleading because creating aserverenvironment would not receive any of the built-inssrconfiguration, so I simply removed this sentence