docs: adding syncing section (#640)
* docs: adding syncing section * chore: fixing constant link
This commit is contained in:
parent
cdfbd51190
commit
0f1befad1f
|
|
@ -134,6 +134,6 @@ The Sonner component is provided by [vue-sonner](https://vue-sonner.vercel.app/)
|
||||||
|
|
||||||
### New Component - Carousel
|
### 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.
|
||||||
|
|
||||||
<ComponentPreview name="CarouselDemo" />
|
<ComponentPreview name="CarouselDemo" />
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,15 @@
|
||||||
title: Contribution
|
title: Contribution
|
||||||
description: Learn on how to contribute to shadcn/vue.
|
description: Learn on how to contribute to shadcn/vue.
|
||||||
---
|
---
|
||||||
|
<script setup lang="ts">
|
||||||
|
import { Button } from "@/lib/registry/new-york/ui/button"
|
||||||
|
|
||||||
|
const latestSyncCommitTag = "06cc0cdf3d080555d26abbe6639f2d7f6341ec73"
|
||||||
|
|
||||||
|
const latestSyncCommitUrl = `https://github.com/shadcn-ui/ui/commit/${latestSyncCommitTag}`
|
||||||
|
const diffUrl = `https://github.com/shadcn-ui/ui/compare/${latestSyncCommitTag}...main`
|
||||||
|
</script>
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
Thanks for your interest in contributing to shadcn-vue.com. We're happy to have you here.
|
Thanks for your interest in contributing to shadcn-vue.com. We're happy to have you here.
|
||||||
|
|
@ -326,6 +335,25 @@ const props = withDefaults(defineProps<Props>(), {
|
||||||
|
|
||||||
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.
|
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 <a :href="latestSyncCommitUrl" target="_blank">commit</a> of `shadcn/ui`.
|
||||||
|
|
||||||
|
Click on the following link to check if there are newer commits that we should be synced with.
|
||||||
|
|
||||||
|
<div class="text-center">
|
||||||
|
<a :href="diffUrl" target="_blank">
|
||||||
|
<Button>
|
||||||
|
Check Diff
|
||||||
|
</Button>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
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
|
## Debugging
|
||||||
Here are some tools and techniques that can help you debug more effectively while contributing to `shadcn/vue` or developing your own projects.
|
Here are some tools and techniques that can help you debug more effectively while contributing to `shadcn/vue` or developing your own projects.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user