diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 34a612bfdc..cd28a7f11c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,7 +17,7 @@ Here are some tips how to make your contributing efforts efficient and eventuall This project uses `makefile` for managing various chores, like dependency installation, testing, linting etc. Make sure you run `make` right after you clone the repository - it will set you up with everything needed to get started. Once you are done with that, have a look at what commands (targets) are available for you to run using `make` - `make install` etc. -## [Decisions](./docs/decisions/README.md) +## [Decisions](https://github.com/lmc-eu/spirit-design-system/blob/main/docs/decisions/README.md) The reasoning behind various decisions made for the Spirit Design System. A good historical record. diff --git a/MIGRATION.md b/MIGRATION.md index 636ba42f83..be6f7d1a91 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -1,3 +1,3 @@ # Migration Guides -Check the [`docs/migrations`](./docs/migrations/) directory to find migration guides for new versions of all packages. +Check the [`docs/migrations`](https://github.com/lmc-eu/spirit-design-system/blob/main/docs/migrations/README.md) directory to find migration guides for new versions of all packages. diff --git a/README.md b/README.md index 96231e69da..7b11eb8ce0 100644 --- a/README.md +++ b/README.md @@ -17,17 +17,17 @@ See individual [packages](#packages) to learn how to get started. ## Packages -| Package name | Description | Version | -| ---------------------------------------------------------------- | ------------------------------------------------------------- | -------------------------------------------------------- | -| [`@lmc-eu/spirit-analytics`](./packages/analytics) | Analytic tools for Spirit Design System | [![@lmc-eu/spirit-analytics][sa-badge]][sa-npm] | -| [`@lmc-eu/spirit-codemods`](./packages/codemods) | Codemod transforms for Spirit Design System version migration | [![@lmc-eu/spirit-codemods][sc-badge]][sc-npm] | -| [`@lmc-eu/spirit-common`](./packages/common) | Common scripts for Spirit Design System | Private | -| [`@lmc-eu/spirit-design-tokens`](./packages/design-tokens) | Design tokens for Spirit Design System | [![@lmc-eu/spirit-design-tokens][sdt-badge]][sdt-npm] | -| [`@lmc-eu/spirit-form-validations`](./packages/form-validations) | Form Validations for Spirit Design System | [![@lmc-eu/spirit-form-validations][sfv-badge]][sfv-npm] | -| [`@lmc-eu/spirit-icons`](./packages/icons) | Icons for Spirit Design System | [![@lmc-eu/spirit-icons][si-badge]][si-npm] | -| [`@lmc-eu/spirit-web`](./packages/web) | CSS and vanilla JS implementation of Spirit Design System | [![@lmc-eu/spirit-web][sw-badge]][sw-npm] | -| [`@lmc-eu/spirit-web-react`](./packages/web-react) | React implementation of Spirit Design System components | [![@lmc-eu/spirit-web-react][swr-badge]][swr-npm] | -| [`@lmc-eu/spirit-web-twig`](./packages/web-twig) | Twig implementation of Spirit Design System components | [![@lmc-eu/spirit-web-twig][swt-badge]][swt-packagist] | +| Package name | Description | Version | +|----------------------------------------------------------------| ------------------------------------------------------------- | -------------------------------------------------------- | +| [`@lmc-eu/spirit-analytics`][packages-analytics] | Analytic tools for Spirit Design System | [![@lmc-eu/spirit-analytics][sa-badge]][sa-npm] | +| [`@lmc-eu/spirit-codemods`][packages-codemods] | Codemod transforms for Spirit Design System version migration | [![@lmc-eu/spirit-codemods][sc-badge]][sc-npm] | +| [`@lmc-eu/spirit-common`][packages-common] | Common scripts for Spirit Design System | Private | +| [`@lmc-eu/spirit-design-tokens`][packages-design-tokens] | Design tokens for Spirit Design System | [![@lmc-eu/spirit-design-tokens][sdt-badge]][sdt-npm] | +| [`@lmc-eu/spirit-form-validations`][packages-form-validations] | Form Validations for Spirit Design System | [![@lmc-eu/spirit-form-validations][sfv-badge]][sfv-npm] | +| [`@lmc-eu/spirit-icons`][packages-icons] | Icons for Spirit Design System | [![@lmc-eu/spirit-icons][si-badge]][si-npm] | +| [`@lmc-eu/spirit-web`][packages-web] | CSS and vanilla JS implementation of Spirit Design System | [![@lmc-eu/spirit-web][sw-badge]][sw-npm] | +| [`@lmc-eu/spirit-web-react`][packages-web-react] | React implementation of Spirit Design System components | [![@lmc-eu/spirit-web-react][swr-badge]][swr-npm] | +| [`@lmc-eu/spirit-web-twig`][packages-web-twig] | Twig implementation of Spirit Design System components | [![@lmc-eu/spirit-web-twig][swt-badge]][swt-packagist] | ## Development @@ -44,13 +44,23 @@ See individual [packages](#packages) to learn how to get started. - `yarn install` - `yarn start` -See [`package.json`](./package.json) for all available tasks. +See [`package.json`][package.json] for all available tasks. ## License See the [LICENSE](LICENSE.md) file for information. [alma-career]: https://github.com/lmc-eu +[packages-analytics]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/analytics +[packages-codemods]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/codemods +[packages-common]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/common +[packages-design-tokens]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/design-tokens +[packages-form-validations]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/form-validations +[packages-icons]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/icons +[packages-web]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/web +[packages-web-react]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/web-react +[packages-web-twig]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/web-twig +[package.json]: https://github.com/lmc-eu/spirit-design-system/blob/main/package.json [sa-badge]: https://img.shields.io/npm/v/%40lmc-eu/spirit-analytics.svg?style=flat-square [sa-npm]: https://www.npmjs.com/package/@lmc-eu/spirit-analytics [sc-badge]: https://img.shields.io/npm/v/%40lmc-eu/spirit-codemods.svg?style=flat-square diff --git a/packages/codemods/src/transforms/v2/web-react/README.md b/packages/codemods/src/transforms/v2/web-react/README.md index e37bb60e5e..753e4af09f 100644 --- a/packages/codemods/src/transforms/v2/web-react/README.md +++ b/packages/codemods/src/transforms/v2/web-react/README.md @@ -2,7 +2,7 @@ This is a collection of codemods for updating Web-React v2 components. -You can find instructions on how to run these codemods in the main package [README](./../../../../README.md). +You can find instructions on how to run these codemods in the main package [README](https://github.com/lmc-eu/spirit-design-system/blob/main/packages/codemods/README.md). ## Included Scripts diff --git a/packages/web-twig/CONTRIBUTING.md b/packages/web-twig/CONTRIBUTING.md index d1c4645c17..a66aa0f212 100644 --- a/packages/web-twig/CONTRIBUTING.md +++ b/packages/web-twig/CONTRIBUTING.md @@ -10,7 +10,7 @@ To start this project simply run `make start` and then add project certificates In a moment the app will be setup and ready on `https://localhost:4443`. -Please consult [`Makefile`](./Makefile) for available commands and options to setup and run this project. +Please consult [`Makefile`](https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-twig/Makefile) for available commands and options to setup and run this project. ## Components definition @@ -34,7 +34,7 @@ This is an example of a typical file structure of a component: ## Rules in components 1. Name of components must be camelCase with first letter small. -2. New components must contain a property class so that they can be extended according to the [instructions](./docs/extendComponents.md) +2. New components must contain a property class so that they can be extended according to the [instructions](https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-twig/docs/extendComponents.md) ```twig {% set _class = (props.class is defined) ? ' ' ~ props.class : '' -%} diff --git a/packages/web-twig/README.md b/packages/web-twig/README.md index 06609af6a8..069ca024ff 100644 --- a/packages/web-twig/README.md +++ b/packages/web-twig/README.md @@ -10,7 +10,7 @@ This is a Symfony bundle with Twig implementation of [Spirit Design System] comp ## Changelog -See [CHANGELOG](./CHANGELOG.md) +See [CHANGELOG](https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-twig/CHANGELOG.md) ## How to install @@ -75,8 +75,8 @@ This is considered a way how you can pass down HTML strings. For available components see the [components directory](https://github.com/lmc-eu/spirit-design-system/tree/main/packages/web-twig/src/Resources/components). -if you want to extend these components, an example guide is [here](./docs/extendComponents.md). -if you want to contribute, read the guide [here](./CONTRIBUTING.md). +if you want to extend these components, an example guide is [here](https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-twig/docs/extendComponents.md). +if you want to contribute, read the guide [here](https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-twig/CONTRIBUTING.md). ## Additional Attributes