Skip to content
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

Clarify docs on context-based store value propagation behavior during SSR #11519

Merged
merged 2 commits into from
Jan 5, 2024

Conversation

juan-db
Copy link
Contributor

@juan-db juan-db commented Jan 4, 2024

Further discussion can be found in this issue #8282.

My interpretation of the current documentation is that changes to the value of the store won't ever propagate if the page is rendered server-side.
The sentence about hydration at the end of the paragraph does technically challenge this interpretation, but I believe the updated version is much clearer about the behavior.

If any of the terminology is incorrect, feel free to correct it. I'm especially unsure about the use of "CSR". I'm not sure if this is technically "hydration" or something else.

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Copy link

changeset-bot bot commented Jan 4, 2024

⚠️ No Changeset found

Latest commit: e5a1deb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@benmccann benmccann added the documentation Improvements or additions to documentation label Jan 5, 2024
Copy link
Member

@dummdidumm dummdidumm left a comment

Choose a reason for hiding this comment

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

Tweaked some more - thank you!

documentation/docs/20-core-concepts/50-state-management.md Outdated Show resolved Hide resolved
@dummdidumm dummdidumm merged commit 2a302b2 into sveltejs:main Jan 5, 2024
10 of 12 checks passed
@juan-db juan-db deleted the patch-1 branch January 5, 2024 16:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants