From e2c358b7f387439c6d7303ecbec59a0f0d02ad77 Mon Sep 17 00:00:00 2001 From: literat Date: Thu, 19 Dec 2024 08:30:14 +0100 Subject: [PATCH] Style(repo): Get rid of all heading capitalization ignore comments in docs --- .remarkrc.mjs | 2 +- DEPRECATIONS-v2.md | 5 ----- DEPRECATIONS-v3.md | 5 ----- configs/jest-config-spirit/README.md | 9 --------- configs/prettier-config-spirit/README.md | 3 --- configs/stylelint-config-spirit/README.md | 3 --- docs/contribution/experimental-code.md | 7 +------ docs/migrations/web-react/MIGRATION-v1.md | 3 --- docs/migrations/web-react/MIGRATION-v2.md | 3 --- docs/migrations/web-react/MIGRATION-v3.md | 3 --- docs/migrations/web-twig/MIGRATION-v2.md | 3 --- docs/migrations/web-twig/MIGRATION-v3.md | 3 --- docs/migrations/web-twig/MIGRATION-v4.md | 3 --- docs/migrations/web/MIGRATION-v1.md | 3 --- docs/migrations/web/MIGRATION-v2.md | 3 --- docs/migrations/web/MIGRATION-v3.md | 3 --- packages/demo/README.md | 3 --- packages/design-tokens/README.md | 6 ------ packages/icons/README.md | 3 --- packages/web-react/DEPRECATIONS.md | 3 --- packages/web-react/README.md | 3 --- packages/web-react/src/components/Toast/README.md | 8 +------- packages/web-twig/DEPRECATIONS.md | 3 --- packages/web/DEPRECATIONS.md | 3 --- packages/web/README.md | 3 --- 25 files changed, 3 insertions(+), 93 deletions(-) diff --git a/.remarkrc.mjs b/.remarkrc.mjs index ad96f6b40b..4a722f12da 100644 --- a/.remarkrc.mjs +++ b/.remarkrc.mjs @@ -39,7 +39,7 @@ export default { { lowerCaseWords: ['v1', 'v2', 'v3', 'v4', 'vs'], exclude: ['`web`', '`web-react`'], - ignorePattern: ['^@lmc-eu/spirit-.*', '^spirit-.*', '`.*`'], + ignorePattern: ['^@lmc-eu/spirit-.*', '^spirit-.*', '`.*`', '.*-config-spirit'], }, ], diff --git a/DEPRECATIONS-v2.md b/DEPRECATIONS-v2.md index 3895ff41b9..3bf2230c96 100644 --- a/DEPRECATIONS-v2.md +++ b/DEPRECATIONS-v2.md @@ -6,9 +6,6 @@ Introducing deprecations and feature flags to be removed in the version 2 lists. 💁 Please follow these steps to safely upgrade your Design System to Spirit Design System v2 components. - - - ## @lmc-eu/spirit-web v2 - [Deprecations][web-deprecations-v2] @@ -19,8 +16,6 @@ Introducing deprecations and feature flags to be removed in the version 2 lists. ## @lmc-eu/spirit-web-twig v2 - - - _spirit-web-twig_ was released as version 2 already. See the [CHANGELOG][twig-changelog] for more details or refer to the [migration guide][twig-migration-v2]. --- diff --git a/DEPRECATIONS-v3.md b/DEPRECATIONS-v3.md index d1f7d82a87..ea15bc7d37 100644 --- a/DEPRECATIONS-v3.md +++ b/DEPRECATIONS-v3.md @@ -6,13 +6,8 @@ Introducing deprecations and feature flags to be removed in the version 3 lists. 💁 Please follow these steps to safely upgrade your Design System to Spirit Design System v3 components. - - - ## @lmc-eu/spirit-web-twig v3 - - - [Deprecations][web-twig-deprecations] --- diff --git a/configs/jest-config-spirit/README.md b/configs/jest-config-spirit/README.md index 3ca4a20490..951af01035 100644 --- a/configs/jest-config-spirit/README.md +++ b/configs/jest-config-spirit/README.md @@ -1,6 +1,3 @@ - - - # jest-config-spirit > Jest configuration and preset for Spirit Design System @@ -17,16 +14,10 @@ yarn add jest-config-spirit ## ⚙️ Configurations - - - ### `jest-preset-spirit/node` The default Jest configuration for Node.js projects. - - - ### `jest-preset-spirit/jsdom` The extension of the default preset for projects that require a browser-like (DOM) environment. diff --git a/configs/prettier-config-spirit/README.md b/configs/prettier-config-spirit/README.md index f59707097d..54649fd4e3 100644 --- a/configs/prettier-config-spirit/README.md +++ b/configs/prettier-config-spirit/README.md @@ -1,6 +1,3 @@ - - - # prettier-config-spirit > Prettier configuration and preset for Spirit Design System diff --git a/configs/stylelint-config-spirit/README.md b/configs/stylelint-config-spirit/README.md index 57bed994d9..59c1cc6703 100644 --- a/configs/stylelint-config-spirit/README.md +++ b/configs/stylelint-config-spirit/README.md @@ -1,6 +1,3 @@ - - - # stylelint-config-spirit > Stylelint configuration and preset for Spirit Design System diff --git a/docs/contribution/experimental-code.md b/docs/contribution/experimental-code.md index cd0ea51bbe..a93653d949 100644 --- a/docs/contribution/experimental-code.md +++ b/docs/contribution/experimental-code.md @@ -79,9 +79,6 @@ documented in each package's main README file in the section `Feature Flags`. All feature flags follow a prefix naming convention that indicates status. - - - #### Flags Prefixed with `enable-*` - Contain new features that we'd like consuming projects to test @@ -95,9 +92,6 @@ All feature flags follow a prefix naming convention that indicates status. If you use these flags, make sure to check our release notes where we'll outline any changes to them across our releases. - - - #### Flags Prefixed with `enable-v#-*` As the usage of an existing flag increases or we determine a feature to be of high @@ -153,6 +147,7 @@ if it can be moved (most of the time the team will initiate this move). The issue should contain the following criteria that need to be met to move a component from experimental to stable: + - [ ] All components are exported through main package export file and should not be `UNSTABLE_` diff --git a/docs/migrations/web-react/MIGRATION-v1.md b/docs/migrations/web-react/MIGRATION-v1.md index f4ee4a3782..9330109859 100644 --- a/docs/migrations/web-react/MIGRATION-v1.md +++ b/docs/migrations/web-react/MIGRATION-v1.md @@ -1,6 +1,3 @@ - - - # Migration Guide Introducing version 1 of the _spirit-web-react_ package diff --git a/docs/migrations/web-react/MIGRATION-v2.md b/docs/migrations/web-react/MIGRATION-v2.md index 0358db04f4..bf0969f86c 100644 --- a/docs/migrations/web-react/MIGRATION-v2.md +++ b/docs/migrations/web-react/MIGRATION-v2.md @@ -1,6 +1,3 @@ - - - # Migration Guide Introducing version 2 of the _spirit-web-react_ package. diff --git a/docs/migrations/web-react/MIGRATION-v3.md b/docs/migrations/web-react/MIGRATION-v3.md index efcb6ea4db..a81ebe7bb5 100644 --- a/docs/migrations/web-react/MIGRATION-v3.md +++ b/docs/migrations/web-react/MIGRATION-v3.md @@ -1,6 +1,3 @@ - - - # Migration Guide Introducing version 3 of the _spirit-web-react_ package. diff --git a/docs/migrations/web-twig/MIGRATION-v2.md b/docs/migrations/web-twig/MIGRATION-v2.md index 71da72eca2..f282d4db24 100644 --- a/docs/migrations/web-twig/MIGRATION-v2.md +++ b/docs/migrations/web-twig/MIGRATION-v2.md @@ -1,6 +1,3 @@ - - - # Migration Guide Introducing version 2 of the _spirit-web-twig_ package diff --git a/docs/migrations/web-twig/MIGRATION-v3.md b/docs/migrations/web-twig/MIGRATION-v3.md index 3aaf0c7c2f..87d533c6a5 100644 --- a/docs/migrations/web-twig/MIGRATION-v3.md +++ b/docs/migrations/web-twig/MIGRATION-v3.md @@ -1,6 +1,3 @@ - - - # Migration Guide Introducing version 3 of the _spirit-web-twig_ package. diff --git a/docs/migrations/web-twig/MIGRATION-v4.md b/docs/migrations/web-twig/MIGRATION-v4.md index 7ae8362a5a..d0cced3146 100644 --- a/docs/migrations/web-twig/MIGRATION-v4.md +++ b/docs/migrations/web-twig/MIGRATION-v4.md @@ -1,6 +1,3 @@ - - - # Migration Guide Introducing version 4 of the _spirit-web-twig_ package. diff --git a/docs/migrations/web/MIGRATION-v1.md b/docs/migrations/web/MIGRATION-v1.md index 03357cb569..f9e48ca438 100644 --- a/docs/migrations/web/MIGRATION-v1.md +++ b/docs/migrations/web/MIGRATION-v1.md @@ -1,6 +1,3 @@ - - - # Migration Guide Introducing version 1 of the _spirit-web_ package diff --git a/docs/migrations/web/MIGRATION-v2.md b/docs/migrations/web/MIGRATION-v2.md index 703d43ff85..739479966d 100644 --- a/docs/migrations/web/MIGRATION-v2.md +++ b/docs/migrations/web/MIGRATION-v2.md @@ -1,6 +1,3 @@ - - - # Migration Guide Introducing version 2 of the _spirit-web_ package. diff --git a/docs/migrations/web/MIGRATION-v3.md b/docs/migrations/web/MIGRATION-v3.md index 0fcebda40b..2288e7afca 100644 --- a/docs/migrations/web/MIGRATION-v3.md +++ b/docs/migrations/web/MIGRATION-v3.md @@ -1,6 +1,3 @@ - - - # Migration Guide Introducing version 3 of the _spirit-web_ package. diff --git a/packages/demo/README.md b/packages/demo/README.md index a7974e9581..5091cabe06 100644 --- a/packages/demo/README.md +++ b/packages/demo/README.md @@ -1,6 +1,3 @@ - - - # @lmc-eu/spirit-demo > Scripts, Styles and Partials for showcase apps of Spirit Design System. diff --git a/packages/design-tokens/README.md b/packages/design-tokens/README.md index ff315a839f..950c55b899 100644 --- a/packages/design-tokens/README.md +++ b/packages/design-tokens/README.md @@ -1,6 +1,3 @@ - - - # @lmc-eu/spirit-design-tokens > Design tokens for Spirit Design System. @@ -157,9 +154,6 @@ module: { - - - #### Using the `sass-embedded` Library If you're using `sass-embedded`, you can specify the API as `legacy`, `modern`, or `modern-compiler`. More information can be found in [sass documentation][sass-embedded]. diff --git a/packages/icons/README.md b/packages/icons/README.md index 8de71ee073..68e56ed9f3 100644 --- a/packages/icons/README.md +++ b/packages/icons/README.md @@ -1,6 +1,3 @@ - - - # @lmc-eu/spirit-icons > Icons of Spirit Design System. diff --git a/packages/web-react/DEPRECATIONS.md b/packages/web-react/DEPRECATIONS.md index 02c3208cd7..8d04729678 100644 --- a/packages/web-react/DEPRECATIONS.md +++ b/packages/web-react/DEPRECATIONS.md @@ -8,9 +8,6 @@ This document lists all deprecations that will be removed in the next major vers 👉 [What are deprecations?][readme-deprecations] - - - ### UncontrolledCollapse `isDisposable` The `hideOnCollapse` prop was removed, please use `isDisposable` instead. diff --git a/packages/web-react/README.md b/packages/web-react/README.md index a9f8dcc880..28c6ace2f4 100644 --- a/packages/web-react/README.md +++ b/packages/web-react/README.md @@ -1,6 +1,3 @@ - - - # @lmc-eu/spirit-web-react [![minified](https://badgen.net/bundlephobia/min/@lmc-eu/spirit-web-react)](https://bundlephobia.com/package/@lmc-eu/spirit-web-react) diff --git a/packages/web-react/src/components/Toast/README.md b/packages/web-react/src/components/Toast/README.md index 5affb2ee81..383cc55c8b 100644 --- a/packages/web-react/src/components/Toast/README.md +++ b/packages/web-react/src/components/Toast/README.md @@ -361,10 +361,7 @@ const { show } = useToast(); // must be inside ToastProvider ; ``` - - - -### useToast Hook +### `useToast` Hook Hook that provides information on `UncontrolledToast` and functions for opening and closing. What is uncontrolled component you can find [here][react-uncontrolled] @@ -382,9 +379,6 @@ This hook returns: | `message` | \[`string` \| `ReactNode`] | null | Message inside UncontrolledToast | | `show` | `(message, toastId, options?) => void` | () => {} | Function that will show UncontrolledToast | - - - #### How to Use `show` Function This function has two required parameters: message and ID. diff --git a/packages/web-twig/DEPRECATIONS.md b/packages/web-twig/DEPRECATIONS.md index 1d5794b3c0..b53ed9ee31 100644 --- a/packages/web-twig/DEPRECATIONS.md +++ b/packages/web-twig/DEPRECATIONS.md @@ -6,9 +6,6 @@ This document lists all deprecations that will be removed in the next major vers ## Deprecations - - - ## Collapse `data-spirit-is-disposable` The `data-spirit-more` attribute was removed, please use `data-spirit-is-disposable` instead. diff --git a/packages/web/DEPRECATIONS.md b/packages/web/DEPRECATIONS.md index 4824922c7f..4296d6a90b 100644 --- a/packages/web/DEPRECATIONS.md +++ b/packages/web/DEPRECATIONS.md @@ -6,9 +6,6 @@ This document lists all deprecations that will be removed in the next major vers ## Deprecations - - - ### Collapse `data-spirit-is-disposable` The `data-spirit-more` attribute was removed, please use `data-spirit-is-disposable` instead. diff --git a/packages/web/README.md b/packages/web/README.md index 478a558524..84cbed215c 100644 --- a/packages/web/README.md +++ b/packages/web/README.md @@ -1,6 +1,3 @@ - - - # @lmc-eu/spirit-web > CSS implementation of Spirit Design System.