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

doc: imporove "Getting Started" section #3800

Closed
4 tasks done
Jannchie opened this issue Jul 23, 2023 · 0 comments · Fixed by #3843
Closed
4 tasks done

doc: imporove "Getting Started" section #3800

Jannchie opened this issue Jul 23, 2023 · 0 comments · Fixed by #3843
Labels
documentation Improvements or additions to documentation pr welcome

Comments

@Jannchie
Copy link
Contributor

Jannchie commented Jul 23, 2023

Clear and concise description of the problem

Hello everyone. I am learning to use vitest. This library seems to assume that all users have experience with jest. Even though I have previous experience with jest development, I am still a bit confused.

As a new user to vitest, I think it is essential to provide examples of how to use the basic api in the "Getting Started" section. However, I see a lot of exciting ways to use vite's advanced features, but I can't find out exactly how I'm supposed to create a unit test.

Suggested solution

I think we can simply refer to jest (https://jestjs.io/docs/getting-started) and add examples of usage.

Although I'm not a native English speaker. I am willing to write a draft if you maintainers find this issue valuable.

Alternative

No response

Additional context

No response

Validations

@sheremet-va sheremet-va added documentation Improvements or additions to documentation pr welcome labels Jul 25, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Aug 14, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation pr welcome
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants