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.

Sign up for GitHub

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

Jump to bottom

[docs] Fix npx folder confusion #2346

Merged
merged 3 commits into from
Jul 25, 2023
Merged

[docs] Fix npx folder confusion #2346

merged 3 commits into from
Jul 25, 2023

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Jul 23, 2023 •
edited
Loading

I got really confused by the my-app description. No, it doesn't work the way it's documented.

Preview: https://deploy-preview-2346--mui-toolpad-docs.netlify.app/toolpad/getting-started/installation/

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Jul 23, 2023
oliviertassinari
oliviertassinari commented Jul 23, 2023
View reviewed changes
docs/src/components/landing/Hero.js Outdated
installation={'npx create-toolpad-app'}
installation="npx create-toolpad-app@latest"
Copy link
Member Author

Choose a reason for hiding this comment

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

If we can trust https://stackoverflow.com/questions/73184553/npx-does-not-look-for-latest-version-of-package

docs/data/toolpad/getting-started/installation.md
```

> This will run the `create-toolpad-app` CLI which initializes the directory `./my-app` with a Toolpad application.
Copy link
Member Author

Choose a reason for hiding this comment

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

This is for quotes

@oliviertassinari oliviertassinari changed the title [docs] Fix npx confusion [docs] Fix npx folder confusion Jul 23, 2023
@oliviertassinari oliviertassinari enabled auto-merge (squash) July 23, 2023 18:02
@bharatkashyap
Copy link
Member

I recommend leaving the folder name argument in the command (something like:)

npx create-toolpad-app@latest my-toolpad-app

since it helps tie in to the second instruction:

Change the current working directory to the application folder:

cd my-toolpad-app

I'm guessing the confusion occurred because of the absence of @latest in the installation instructions, since older versions of the CLI didn't take in the folder name argument.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 24, 2023
@oliviertassinari
Copy link
Member Author

oliviertassinari commented Jul 24, 2023 •
edited
Loading

I'm guessing the confusion occurred because of the absence of @latest in the installation instructions, since older versions of the CLI didn't take in the folder name argument.

Ahhhhhh, I wasn't using the latest version 🤦‍♂️. Maybe one day npm will fix this npm/cli#4108

@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 24, 2023
@oliviertassinari oliviertassinari merged commit 1d85ac3 into mui:master Jul 25, 2023
@oliviertassinari oliviertassinari mentioned this pull request Dec 26, 2023
Merged
@oliviertassinari oliviertassinari mentioned this pull request Apr 26, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Janpot Janpot Janpot left review comments

@bharatkashyap bharatkashyap bharatkashyap approved these changes

Assignees
No one assigned
Labels
docs Improvements or additions to the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@oliviertassinari @bharatkashyap @Janpot