From f5448b74619e16e3f3579c002031d9de30e951bb Mon Sep 17 00:00:00 2001 From: Saeid Zareie Date: Fri, 15 Mar 2024 20:21:14 +0330 Subject: [PATCH] docs: fixing some issues on CONTRIBUTING.md --- CONTRIBUTING.md | 39 +++++++++++++++++++-------------------- 1 file changed, 19 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 31bf7db9..8970fe1c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,7 @@ This repository is structured as follows: ``` apps └── www - ├── src + ├── src │ └── content └── registry ├── default @@ -32,12 +32,12 @@ packages └── cli ``` -| Path | Description | -| --------------------- | ---------------------------------------- | -| `apps/www/app` | The Next.js application for the website. | -| `apps/www/content` | The content for the website. | -| `apps/www/registry` | The registry for the components. | -| `packages/cli` | The `shadcn-vue` package. | +| Path | Description | +| ----------------------------| -------------------------------------------| +| `apps/www/.vitepress` | The Vitepress application for the website. | +| `apps/www/src/content` | The content for the website. | +| `apps/www/src/lib/registry` | The registry for the components. | +| `packages/cli` | The `shadcn-vue` package. | ## Development @@ -79,22 +79,24 @@ The documentation for this project is located in the `www` workspace. You can ru pnpm dev ``` -Documentation is written using [md](https://vitepress.dev/guide/markdown). You can find the documentation files in the `apps/www/content/docs` directory. +Documentation is written using [md](https://vitepress.dev/guide/markdown). You can find the documentation files in the `apps/www/src/content` directory. ## Components -We use a registry system for developing components. You can find the source code for the components under `apps/www/registry`. The components are organized by styles. +We use a registry system for developing components. You can find the source code for the components under `apps/www/src/lib/registry`. The components are organized by styles. ```bash apps └── www - └── registry - ├── default - │ ├── example - │ └── ui - └── new-york - ├── example - └── ui + └── src + └── lib + └── registry + ├── default + │ ├── example + │ └── ui + └── new-york + ├── example + └── ui ``` When adding or modifying components, please ensure that: @@ -130,13 +132,10 @@ the following categories: e.g. `feat(components): add new prop to the avatar component` - If you are interested in the detailed specification you can visit https://www.conventionalcommits.org/ or check out the [Angular Commit Message Guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines). - - ## Requests for new components If you have a request for a new component, please open a discussion on GitHub. We'll be happy to help you out. @@ -155,4 +154,4 @@ Tests are written using [Vitest](https://vitest.dev). You can run all the tests pnpm test ``` -Please ensure that the tests are passing when submitting a pull request. If you're adding new features, please include tests. \ No newline at end of file +Please ensure that the tests are passing when submitting a pull request. If you're adding new features, please include tests.