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(*): change 'npm i' to 'npm install' #2865

Merged
merged 8 commits into from
Dec 18, 2024

Conversation

sukvvon
Copy link
Contributor

@sukvvon sukvvon commented Dec 16, 2024

Summary

  • Since this is an official document, I determined that using npm install instead of the abbreviation npm i is more appropriate, so I made the change.
  • In the official homepage, both npm install and npm i are used, so I standardizied them.

Check List

  • pnpm run prettier for formatting code and docs

Copy link

vercel bot commented Dec 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
jotai ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 18, 2024 3:06am

Copy link

codesandbox-ci bot commented Dec 16, 2024

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Copy link

pkg-pr-new bot commented Dec 16, 2024

Open in Stackblitz

More templates

npm i https://pkg.pr.new/jotai@2865

commit: 1c8fd7a

Copy link

github-actions bot commented Dec 16, 2024

LiveCodes Preview in LiveCodes

Latest commit: 1c8fd7a
Last updated: Dec 18, 2024 3:05am (UTC)

Playground Link
React demo https://livecodes.io?x=id/EW8Z62HC4

See documentations for usage instructions.

Copy link
Member

@dai-shi dai-shi left a comment

Choose a reason for hiding this comment

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

I'm fine with this change, but I would like to hear from someone else. How about @dmaskasky and @sandren ?

readme.md Outdated
@@ -5,7 +5,7 @@

<br>

visit [jotai.org](https://jotai.org) or `npm i jotai`
Copy link
Member

Choose a reason for hiding this comment

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

At least, this was very intentional.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes, let's keep the shorthand here at least. 🙂

@sandren
Copy link
Collaborator

sandren commented Dec 18, 2024

I'm fine with this change, but I would like to hear from someone else. How about @dmaskasky and @sandren ?

I like the change too. I think it's good to be more explicit in most places, but agree with @dai-shi that the shorthand is nice at the top of the readme at least. Thanks! ☺️

@dai-shi
Copy link
Member

dai-shi commented Dec 18, 2024

Okay, let's do that.

readme.md Outdated Show resolved Hide resolved
Co-authored-by: Daishi Kato <[email protected]>
@dai-shi
Copy link
Member

dai-shi commented Dec 18, 2024

@sukvvon When you have a chance, I'd appreciate if you can look into the flaky test issue. We've been struggling with it with no clues yet.
https://github.com/pmndrs/jotai/actions/runs/12385559467/job/34572020212?pr=2865

@sukvvon
Copy link
Contributor Author

sukvvon commented Dec 18, 2024

@sukvvon When you have a chance, I'd appreciate if you can look into the flaky test issue. We've been struggling with it with no clues yet. https://github.com/pmndrs/jotai/actions/runs/12385559467/job/34572020212?pr=2865

@dai-shi If I have time, I will take a look.

Copy link
Member

@dai-shi dai-shi left a comment

Choose a reason for hiding this comment

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

LGTM

@dai-shi dai-shi merged commit a9933f1 into pmndrs:main Dec 18, 2024
42 checks passed
@sukvvon sukvvon deleted the docs/npm-i-to-install branch December 18, 2024 03:14
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.

3 participants