diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 735b4c2..19afb68 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,7 @@ Want to contribute to Cunningham? We got you covered. We try to raise our code quality standards and expect contributors to follow -the recommandations from our [handbook](https://handbook.openfun.fr/). +the recommandations from our [handbook](https://suitenumerique.gitbook.io/handbook). ## Development @@ -36,7 +36,7 @@ make build When submitting please follow those steps: -- Make sure you followed the commit conventions from the [handbook/git](https://handbook.openfun.fr/git). +- Make sure you followed the commit conventions from the [handbook/git](https://suitenumerique.gitbook.io/handbook/git). - Make sure that you added tests covering your changes. - Run `make deploy` to tests, lint and build the project. - Create a [changeset](#adding-a-changeset) by running `yarn changeset` at the root of the repo. In any case, a bot will verify if your PR contains a changeset. diff --git a/README.md b/README.md index f8109d9..80758e5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@
- +
@@ -8,21 +8,21 @@ **A design system and a components library.** -📚  Documentation â€ĸ +📚  Documentation â€ĸ 🖌ī¸  Figma â€ĸ -🕹ī¸  Demo +🕹ī¸  Demo
- **Atomic**: We follow [atomic design principles](https://bradfrost.com/blog/post/atomic-web-design/). - **Modular and Reusable**: Each component is designed to be self-contained and reusable across different projects, promoting consistency and saving development time. - **Accessibility-focused**: Our components prioritize accessibility standards, making them usable and inclusive for all users. -- **Design tokens based**: We use [design tokens](https://openfun.github.io/cunningham/storybook/?path=/docs/getting-started-customization--docs#what-are-design-tokens-) to ensure consistency between design and code and allow high customization. +- **Design tokens based**: We use [design tokens](https://suitenumerique.github.io/cunningham/storybook/?path=/docs/getting-started-customization--docs#what-are-design-tokens-) to ensure consistency between design and code and allow high customization. - **React** based: at the moment we only support React, but we are open to other frameworks, feel free to [contribute](./CONTRIBUTING.md) !
-[![CircleCI](https://circleci.com/gh/openfun/cunningham/tree/main.svg?style=svg)](https://circleci.com/gh/openfun/cunningham/tree/main) +[![CircleCI](https://circleci.com/gh/suitenumerique/cunningham/tree/main.svg?style=svg)](https://circleci.com/gh/suitenumerique/cunningham/tree/main) [![Discord](https://img.shields.io/discord/1082704478463082496?style=flat&logo=discord&label=discord&labelColor=5b61f1&logoColor=white&color=313338)](https://discord.gg/TXPSCMeDzd)
@@ -31,11 +31,11 @@ Here are some examples of real life usage of Cunningham components. - +
-See the [documentation](https://openfun.github.io/cunningham/storybook) 📚 to learn more about customization, typography, spacings and available components! +See the [documentation](https://suitenumerique.github.io/cunningham/storybook) 📚 to learn more about customization, typography, spacings and available components!
@@ -74,18 +74,18 @@ It will generate a file named `cunningham-tokens.css`. @import "cunningham-tokens"; // Imports the file you just generated. ``` -> Please take a look at [customization documentation](https://openfun.github.io/cunningham/storybook/?path=/docs/getting-started-customization--docs) for more informations about the `cunningham` command line tool and to customize your local theme. +> Please take a look at [customization documentation](https://suitenumerique.github.io/cunningham/storybook/?path=/docs/getting-started-customization--docs) for more informations about the `cunningham` command line tool and to customize your local theme. We're done! 🎉 -To ensure everything works well, let's test rendering a component, such as the [Button](https://openfun.github.io/cunningham/storybook/?path=/docs/components-button--docs) for example. +To ensure everything works well, let's test rendering a component, such as the [Button](https://suitenumerique.github.io/cunningham/storybook/?path=/docs/components-button--docs) for example. -Now please see the [documentation](https://openfun.github.io/cunningham/storybook) 📚 to learn more about customization, typography, spacings and available components! +Now please see the [documentation](https://suitenumerique.github.io/cunningham/storybook) 📚 to learn more about customization, typography, spacings and available components! ## Contributors - - + + ## Contributing diff --git a/apps/demo/CHANGELOG.md b/apps/demo/CHANGELOG.md index b1a3ae6..da517e6 100644 --- a/apps/demo/CHANGELOG.md +++ b/apps/demo/CHANGELOG.md @@ -36,10 +36,10 @@ - 2a5acea: The CSS utility classes are no longer automatically included when using Cunningham bin. -[unreleased]: https://github.com/openfun/cunningham/compare/cunningham-demo@3.0.0...main -[3.0.0]: https://github.com/openfun/cunningham/compare/cunningham-demo@2.0.0...cunningham-demo@3.0.0 -[2.0.0]: https://github.com/openfun/cunningham/compare/cunningham-demo@1.0.1...cunningham-demo@2.0.0 -[1.0.1]: https://github.com/openfun/cunningham/compare/cunningham-demo@1.0.0...cunningham-demo@1.0.1 -[1.0.0]: https://github.com/openfun/cunningham/compare/cunningham-demo@0.1.0...cunningham-demo@1.0.0 -[0.1.0]: https://github.com/openfun/cunningham/compare/cunningham-demo@0.0.1...cunningham-demo@0.1.0 -[0.0.1]: https://github.com/openfun/cunningham/compare/0b532742e7f9747c5d573b869daa8aca0d79e7f1...cunningham-demo@0.0.1 +[unreleased]: https://github.com/suitenumerique/cunningham/compare/cunningham-demo@3.0.0...main +[3.0.0]: https://github.com/suitenumerique/cunningham/compare/cunningham-demo@2.0.0...cunningham-demo@3.0.0 +[2.0.0]: https://github.com/suitenumerique/cunningham/compare/cunningham-demo@1.0.1...cunningham-demo@2.0.0 +[1.0.1]: https://github.com/suitenumerique/cunningham/compare/cunningham-demo@1.0.0...cunningham-demo@1.0.1 +[1.0.0]: https://github.com/suitenumerique/cunningham/compare/cunningham-demo@0.1.0...cunningham-demo@1.0.0 +[0.1.0]: https://github.com/suitenumerique/cunningham/compare/cunningham-demo@0.0.1...cunningham-demo@0.1.0 +[0.0.1]: https://github.com/suitenumerique/cunningham/compare/0b532742e7f9747c5d573b869daa8aca0d79e7f1...cunningham-demo@0.0.1 diff --git a/apps/demo/src/Home.tsx b/apps/demo/src/Home.tsx index 84cb045..772cbd6 100644 --- a/apps/demo/src/Home.tsx +++ b/apps/demo/src/Home.tsx @@ -197,7 +197,7 @@ export const Home = ({ modal }: { modal: PageProps }) => { color="neutral" target="_blank" rel="noopener noreferrer" - href="https://github.com/openfun/cunningham" + href="https://github.com/suitenumerique/cunningham" > Github @@ -209,7 +209,7 @@ export const Home = ({ modal }: { modal: PageProps }) => { color="neutral" target="_blank" rel="noopener noreferrer" - href="https://openfun.github.io/cunningham/storybook" + href="https://suitenumerique.github.io/cunningham/storybook" > Documentation diff --git a/apps/demo/src/Onboarding.tsx b/apps/demo/src/Onboarding.tsx index a22a554..cb394f8 100644 --- a/apps/demo/src/Onboarding.tsx +++ b/apps/demo/src/Onboarding.tsx @@ -29,7 +29,7 @@ const Onboarding = () => { Let's go!