diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 92b6a289..ab68a545 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,7 +49,7 @@ There are two aspects of code review: giving and receiving. To make it easier fo * Write good commit messages * Break large changes into a logical series of smaller patches which individually make easily understandable changes, and in aggregate solve a broader issue -Reviewers, the people giving the review, are highly encouraged to revisit our [Code of Conduct](./CODE_OF_CONDUCT.md) and must go above and beyond to promote a collaborative, respectful community. When reviewing PRs from others [The Gentle Art of Patch Review](https://sage.thesharps.us/2014/09/01/the-gentle-art-of-patch-review/) suggests an iterative series of focuses which is designed to lead new contributors to positive collaboration without inundating them initially with a pile of suggestions: +Reviewers, the people giving the review, are highly encouraged to revisit our [Code of Conduct](./CODE-OF-CONDUCT.md) and must go above and beyond to promote a collaborative, respectful community. When reviewing PRs from others [The Gentle Art of Patch Review](https://sage.thesharps.us/2014/09/01/the-gentle-art-of-patch-review/) suggests an iterative series of focuses which is designed to lead new contributors to positive collaboration without inundating them initially with a pile of suggestions: 1. Is the idea behind the contribution sound? 1. Is the contribution architected correctly? diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 987fd720..a87adf87 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -127,5 +127,10 @@ export default defineConfig({ } ] } - } + }, + + ignoreDeadLinks: [ + './CODE-OF-CONDUCT', + './GOVERNANCE' + ] }) diff --git a/docs/.vitepress/theme/components/Home.vue b/docs/.vitepress/theme/components/Home.vue index 35379299..82d64847 100644 --- a/docs/.vitepress/theme/components/Home.vue +++ b/docs/.vitepress/theme/components/Home.vue @@ -11,13 +11,16 @@ import { VueMarqueeSlider } from 'vue3-marquee-slider' Install -
+

HoW does it WoRK?

Kit is an open source MLOps project that packages your model, datasets, code, and configuration so data scientists and developers can use their preferred tools while collaborating effortlessly.
- screenshot of the kit cli tool +
@@ -75,7 +78,7 @@ import { VueMarqueeSlider } from 'vue3-marquee-slider'
-
+

Get stArted

diff --git a/docs/src/public/how-it-works.mp4 b/docs/src/public/how-it-works.mp4 new file mode 100644 index 00000000..37554a26 Binary files /dev/null and b/docs/src/public/how-it-works.mp4 differ