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

inappropriate installation guide #7869

Closed
Jay-Karia opened this issue Aug 8, 2024 · 5 comments · Fixed by #7881
Closed

inappropriate installation guide #7869

Jay-Karia opened this issue Aug 8, 2024 · 5 comments · Fixed by #7881

Comments

@Jay-Karia
Copy link
Contributor

Jay-Karia commented Aug 8, 2024

Describe the bug

The installation guide at https://tanstack.com/query/latest/docs/framework/react/installation has a section called "NPM" which shows scripts to install the package which also includes pnpm, yarn, and bun.

Your minimal, reproducible example

https://tanstack.com/query/latest/docs/framework/react/installation

Steps to reproduce

  1. Go to installation guide
  2. Visit "NPM" section

Expected behavior

I expect to have different sections for different package managers.

How often does this bug happen?

None

Platform

OS: Win 10
Browser: Chrome

Tanstack Query adapter

None

TanStack Query version

v5

TypeScript version

v4.5

@TkDodo
Copy link
Collaborator

TkDodo commented Aug 9, 2024

you still install from npm (the registry) even if you use pnpm or yarn.

@TkDodo TkDodo closed this as not planned Won't fix, can't repro, duplicate, stale Aug 9, 2024
@Jay-Karia
Copy link
Contributor Author

The copy button will copy the full text (including yarn and pnpm commands ) with comments.
So dividing them might improve DX

@TkDodo
Copy link
Collaborator

TkDodo commented Aug 9, 2024

then please make a PR to split the instructions only; but I think this isn't the only place in the docs where we do this. Search for yarn add in the docs directory

@Jay-Karia
Copy link
Contributor Author

So, it should look like this:

...

NPM

Npm script
Pnpm script
Yarn script
Bun script

...

@Jay-Karia
Copy link
Contributor Author

@TkDodo, Fixed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants