From dc30a4bc1a82dea25075ed6b6c5a2f0604525071 Mon Sep 17 00:00:00 2001 From: Saeid Zareie Date: Sun, 30 Jun 2024 19:58:38 +0330 Subject: [PATCH] docs: adding syncing section --- apps/www/src/content/docs/changelog.md | 2 +- apps/www/src/content/docs/contribution.md | 25 +++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) diff --git a/apps/www/src/content/docs/changelog.md b/apps/www/src/content/docs/changelog.md index 26f8dd31..ce99836c 100644 --- a/apps/www/src/content/docs/changelog.md +++ b/apps/www/src/content/docs/changelog.md @@ -134,6 +134,6 @@ The Sonner component is provided by [vue-sonner](https://vue-sonner.vercel.app/) ### New Component - Carousel -[`Carousel`](/docs/components/toggle-group.html) - A carousel with motion and swipe built using [Embla](https://www.embla-carousel.com/) library. +[`Carousel`](/docs/components/carousel.html) - A carousel with motion and swipe built using [Embla](https://www.embla-carousel.com/) library. diff --git a/apps/www/src/content/docs/contribution.md b/apps/www/src/content/docs/contribution.md index 14fcdca3..2d3a193f 100644 --- a/apps/www/src/content/docs/contribution.md +++ b/apps/www/src/content/docs/contribution.md @@ -2,6 +2,13 @@ title: Contribution description: Learn on how to contribute to shadcn/vue. --- + + ## Introduction Thanks for your interest in contributing to shadcn-vue.com. We're happy to have you here. @@ -326,6 +333,24 @@ const props = withDefaults(defineProps(), { You'll need to extend `PrimitiveProps` in your props to support `Primitive` component. In most cases you would also need a default value for [`as`](https://www.radix-vue.com/utilities/primitive.html#changing-as-value) property. +## Updating with `shadcn/ui` + +`shadcn/vue` is an unofficial, community-led Vue port of `shadcn/ui`, as time goes by, they might get out of sync. +as of today, we are in sync with this [commit](https://github.com/shadcn-ui/ui/commit/06cc0cdf3d080555d26abbe6639f2d7f6341ec73) of `shadcn/ui`. + +There is a recommended process to keep track of the updates and applying them here in `shadcn/vue`, click on the following link to check if there are newer commits that we should be synced with. + + + +1. There are no changes - If you see "There isn’t anything to compare", nothing needs to be done as we are synced with latest version. +2. If there are changes, you should review thoese changes and try to apply them on `shadcn/vue` codebase and create a PR, remember to update the `latestSyncCommitTag` in [this file](https://github.com/radix-vue/shadcn-vue/blob/dev/apps/www/src/content/docs/contribution.md) too. + ## Debugging Here are some tools and techniques that can help you debug more effectively while contributing to `shadcn/vue` or developing your own projects.