Skip to content

docs: rewrite context docs #15541

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

Merged
merged 2 commits into from
Mar 19, 2025
Merged

docs: rewrite context docs #15541

merged 2 commits into from
Mar 19, 2025

Conversation

Rich-Harris
Copy link
Member

Noticed while reviewing #15533 — our context docs are really rather strange:

  • they talk exclusively about state, when oftentimes context doesn't involve state at all (see the tutorial for example)
  • it doesn't even talk about context until you get below the fold (and inexplicably puts the first mention inside backticks). Instead it talks awkwardly about global state and talks vaguely about 'drawbacks' without illustrating what the supposed danger is
  • 'slotted content'
  • it doesn't explain how reassigning context breaks the link, which is the main thing people have run into

In short it needed a complete rewrite

Copy link

changeset-bot bot commented Mar 19, 2025

⚠️ No Changeset found

Latest commit: ece367e

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

@svelte-docs-bot
Copy link

Copy link
Contributor

Playground

pnpm add https://pkg.pr.new/svelte@15541

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.

much better 👍

@dummdidumm dummdidumm merged commit 701f085 into main Mar 19, 2025
13 checks passed
@dummdidumm dummdidumm deleted the overhaul-context-docs branch March 19, 2025 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy