Skip to content

Fix contributing playground paths #3875

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

Closed
Bojun-Vvibe wants to merge 1 commit into from
+4 −4
Closed

Fix contributing playground paths #3875

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Please ensure that the tests are passing when submitting a pull request. If you'

## Running playgrounds

Currently the `React` playground (located in `packages/playground-react`) is a Next.js app that contains some examples which you can find in the `pages` directory. The `Vue` playground (located in `packages/playground-vue`) is a Vite app that contains some examples which you can find in the `src/components` directory.
Currently the `React` playground (located in `playgrounds/react`) is a Next.js app that contains some examples which you can find in the `pages` directory. The `Vue` playground (located in `playgrounds/vue`) is a Vite app that contains some examples which you can find in the `src/components` directory.

You can launch them by running:

Expand Down Expand Up @@ -103,7 +103,7 @@ Scripts per package:
- `npm run react watch`: start a watcher for the react esm build
- **Note**: this will be executed for you when using the `npm run react playground`
- **Note**: this is not required for jest. You will probably never need this
- `npm run react playground`: (alias) start a development server in the `playground-react` package
- `npm run react playground`: (alias) start a development server in the `playgrounds/react` package
- **Note**: this will also run `npm run react watch` for you, which means that you only need to execute `npm run react playground`
- `npm run react clean`: this will remove `dist` files
- `npm run vue`: Prefix to run anything in the `@headlessui/vue` package
Expand All @@ -116,6 +116,6 @@ Scripts per package:
- `npm run vue watch`: start a watcher for the vue esm build
- **Note**: this will be executed for you when using the `npm run vue playground`
- **Note**: this is not required for jest. You will probably never need this
- `npm run vue playground`: (alias) start a development server in the `playground-vue` package
- **Note**: this will also run `npm run vue watch` for you, which means that you only need to execute `npm run react playground`
- `npm run vue playground`: (alias) start a development server in the `playgrounds/vue` package
- **Note**: this will also run `npm run vue watch` for you, which means that you only need to execute `npm run vue playground`
- `npm run vue clean`: this will remove `dist` files