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: update install section #23

Merged
merged 3 commits into from
Jun 30, 2024
Merged

Conversation

minsoo-web
Copy link
Member

@minsoo-web minsoo-web commented Jun 30, 2024

I update installation section with vitepress api

  • Add Prerequisites
  • combine Nodejs with bun with code-group

preview

image

Copy link

vercel bot commented Jun 30, 2024

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

Name Status Preview Comments Updated (UTC)
overlay-kit ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 30, 2024 1:42pm

Copy link
Member

@jungpaeng jungpaeng left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution. The document is significantly improved!

@jungpaeng jungpaeng merged commit f58235a into toss:main Jun 30, 2024
2 checks passed
Copy link
Member

@manudeli manudeli left a comment

Choose a reason for hiding this comment

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

@minsoo-web @jungpaeng Check this out please

## Node.js
## Prerequisites

- [React](https://react.dev/) version 18 or higher.
Copy link
Member

@manudeli manudeli Jun 30, 2024

Choose a reason for hiding this comment

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

👀🦅 "higher" should be corrected. ^18 only cover major version 18. not 19 so In my opinion, this should be updated

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree about this, I will make update PR

Copy link
Member

Choose a reason for hiding this comment

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

Thanks! ❤️

Copy link
Member Author

Choose a reason for hiding this comment

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

Before making a fix, as @manudeli mentioned, currently overlay-kit only covers react 18 version.
I wonder if this will be a problem for specifying dependencies higher react 18 version.

It would be good to talk about whether I should modify the docs or modify of a package.json that covers dependencies >= 18

Copy link
Member

@manudeli manudeli Jun 30, 2024

Choose a reason for hiding this comment

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

In my opinion, >= 18 meaning contain not only 19, also 20, 30 so It would be better that ^18 || ^19 is enough or don't add it yet before releasing 19

Copy link
Member Author

@minsoo-web minsoo-web Jun 30, 2024

Choose a reason for hiding this comment

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

@manudeli plz check #25 , thanks!

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