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

Docs : Remove ‘$’ from Installation Commands in Documentation #7293

Open
Mandeep56Singh opened this issue Apr 17, 2024 · 0 comments
Open

Comments

@Mandeep56Singh
Copy link

Mandeep56Singh commented Apr 17, 2024

I’ve been using the React Query library and found the documentation to be very helpful. However, I noticed that the installation commands in the documentation include a dollar sign (‘$’) at the beginning. For example:

$ npm install react-query

When copying the command from the documentation and pasting it into the terminal in these IDEs, the dollar sign is also copied. This leads to an invalid command for those users who use IDE like VS code with bash terminal which already provide you with "$".

I suggest removing the dollar sign from the commands in the documentation

This small change could greatly improve the user experience for developers who copy paste fast like me.

Thank you for considering this issue.

Your minimal, reproducible example

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

Steps to reproduce

1.Go to Installation Page i.e. https://tanstack.com/query/v3/docs/framework/react/installation
2.Copy the Installation command i.e $ npm i react-query
3.Open your IDE terminal like VS Code terminal , Paste it
4.Run the command and see the issue

Expected behavior

Installation Command should not include "$" sign

Screenshots

This is the documentation page

Screenshot (145)

After copy , Your terminal doesn't recognize it as bash command due to additional dollar sign
Screenshot (146)

Platform

OS: Windows

Tanstack Query adapter

None

TanStack Query version

latest

I can contribute to this if you want . This will be my tribute to TanStack community

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

No branches or pull requests

1 participant