Skip to content

Conversation

@AppSynergy
Copy link

@AppSynergy AppSynergy commented Dec 17, 2025

🎯 Changes

#1039 (comment)

Experiences of a first time user being a bit confused by some of the documentation, does this look any use?

  • Affects examples in overview and quick-start docs.
  • Adds queryClient to several snippets, seems like this is required to be there.
  • Also adds getKey to one, for similar reasons.
  • Ignores those that are clearly incomplete, e.g. // ...your config.
  • Adds await and .json() to one example, making it more similar to the others and more likely to be the right type.
  • Adds an interface to the main example on quick-start, allowing type inference to work, hopefully making it complete.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm test:pr.
  • Docs only, and CONTRIBUTING.md doesn't seem to exist.
  • Have tested only as much as checking that eslint is happier with these examples now.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

…her things that feel like they should be there.
@changeset-bot
Copy link

changeset-bot bot commented Dec 17, 2025

⚠️ No Changeset found

Latest commit: 5cfaf86

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

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.

1 participant