191 update docs introduction section #196
Conversation
…de into docs Others section
✅ Deploy Preview for jest-preview-library ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
website/docs/others/contributing.md
Outdated
|
|
||
| # Contributing | ||
|
|
||
| ## Welcome | ||
|
|
||
| Welcome to CONTRIBUTING zone. If you are reading this, you probably want to contribute to Open Source projects. That's great! Contributing to an open source project is a great opportunity to learn, sharpen your skills and help others. Luckily, Jest Preview is a free and open source project and we always welcome new contributors. Its mission is to help front end developers' lives easier and more enjoyable, also improve the standard of front end applications by encouraging them to write more high-quality tests, by providing an ability to view the actual UI in Jest in an external browser like Chrome. | ||
|
|
||
| Jest Preview aims to be a community-driven project. So we hope to see your contributions to make Jest Preview a favorite library for front end developers when it comes to testing. | ||
|
|
||
| ## What can I contribute? | ||
|
|
||
| We appreciated any help. There is not a thing as a small contribution. If you see a typo, send us a PR. If you experience a bug, please open an issue. If you have a suggestion, let us know. Below are some ways you can contribute to Jest Preview: |
There was a problem hiding this comment.
Actually, when building the docs website, we will copy the content from CONTRIBUTING.md to website/docs/others/contributing.md.
You can see the source code here and the docs website that already has contributing guideline:
https://www.jest-preview.com/docs/others/contributing
(You can see that contributing is duplicated in https://deploy-preview-196--jest-preview-library.netlify.app/docs/others/contributing)
I guess you want to reverse the changes in this file.
If you want to update contributing guideline, please make the change directly in CONTRIBUTING.md
|
|
||
| ## Online Demo | ||
|
|
||
| You can try Jest Preview right on the browser without installing or cloning anything, thanks to [StackBlitz](https://stackblitz.com/): | ||
| Want to try the library before installing it? We got you covered! Check out [StackBlitz Demo App](https://stackblitz.com/edit/jest-preview?embed=1&file=package.json) or try it right here 😉 |
There was a problem hiding this comment.
Please link to README.md instead of package.json
| Want to try the library before installing it? We got you covered! Check out [StackBlitz Demo App](https://stackblitz.com/edit/jest-preview?embed=1&file=package.json) or try it right here 😉 | |
| Want to try the library before installing it? We got you covered! Check out [StackBlitz Demo App](https://stackblitz.com/edit/jest-preview?file=README.md) or try it right here 😉 |
There was a problem hiding this comment.
Changed to Readme.md
|
|
||
| You also need to start the Jest Preview Server by running the CLI `jest-preview`. Please continue to read [Usage](/docs/getting-started/usage) for the details instructions. |
There was a problem hiding this comment.
I have a suggestion here. Since the simple instruction above does not support CSS and viewing images yet. So we mention something like "To make it look even better, follow the Installation guide"
There was a problem hiding this comment.
Added Installation guide link as per your suggestion
|
@all-contributors please add @skirianov for doc and content |
|
I've put up a pull request to add @skirianov! 🎉 |
Summary/ Motivation (TLDR;)
General refactoring/rewriting of the Introduction page.
Note: this is just preview PR, once changes are discussed and approved before merge "Why Jest Preview" link will be removed.
Related issues
Features
Fixes
Chores