From ad30bbefe8a3646b9a6134777bcd9c6d221e8518 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jakub=20=C4=8Curda?= <jakub.curda@almacareer.com>
Date: Fri, 4 Oct 2024 09:31:29 +0200
Subject: [PATCH] Docs: Button and ButtonLink have isSymmetrical prop instead
 of isSquare #DS-1484

---
 docs/migrations/web-react/MIGRATION-v3.md | 46 +++++++++++++++++++++++
 docs/migrations/web-twig/MIGRATION-v4.md  | 30 +++++++++++++++
 docs/migrations/web/MIGRATION-v3.md       | 24 ++++++++++++
 3 files changed, 100 insertions(+)
 create mode 100644 docs/migrations/web-react/MIGRATION-v3.md
 create mode 100644 docs/migrations/web-twig/MIGRATION-v4.md
 create mode 100644 docs/migrations/web/MIGRATION-v3.md

diff --git a/docs/migrations/web-react/MIGRATION-v3.md b/docs/migrations/web-react/MIGRATION-v3.md
new file mode 100644
index 0000000000..edf85ddda3
--- /dev/null
+++ b/docs/migrations/web-react/MIGRATION-v3.md
@@ -0,0 +1,46 @@
+# Migration Guide
+
+Introducing version 3 of the _spirit-web-react_ package.
+
+> Please follow these steps to safely upgrade to Spirit Design System v3 components.
+
+> ℹ️ Don't forget to check the [migration guide of the _spirit-web_ package][migration-guide-web] for general changes in
+> available feature flags, CSS, and other changes that might affect your project.
+
+## Overview
+
+- [Component Changes](#component-changes)
+  - [Button and ButtonLink: `isSquare` prop](#button-and-buttonlink-issquare-prop-renamed-to-issymmetrical)
+
+## Component Changes
+
+### Button and ButtonLink: `isSquare` prop renamed to `isSymmetrical`
+
+Button `isSquare` prop was renamed to `isSymmetrical`.
+
+#### Migration Guide
+
+🪄 Use codemods to automatically update your codebase:
+
+```sh
+npx @lmc-eu/spirit-codemods -p <path> -t v3/web-react/button-isSquare-prop-name
+npx @lmc-eu/spirit-codemods -p <path> -t v3/web-react/buttonLink-isSquare-prop-name
+```
+
+👉 See [Codemods documentation][readme-codemods] for more details.
+
+<details>
+  <summary>🔧 Manual Migration Steps</summary>
+
+Manually replace the props in your project.
+
+- `<Button isSquare … />` → `<Button isSymmetrical … />`
+- `<ButtonLink isSquare … />` → `<ButtonLink isSymmetrical … />`
+</details>
+
+---
+
+Please refer back to these instructions or reach out to our team if you encounter any issues during migration.
+
+[migration-guide-web]: https://github.com/lmc-eu/spirit-design-system/blob/main/docs/migrations/web/MIGRATION-v3.md
+[readme-codemods]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/codemods/README.md
diff --git a/docs/migrations/web-twig/MIGRATION-v4.md b/docs/migrations/web-twig/MIGRATION-v4.md
new file mode 100644
index 0000000000..49235b7e5e
--- /dev/null
+++ b/docs/migrations/web-twig/MIGRATION-v4.md
@@ -0,0 +1,30 @@
+# Migration Guide
+
+Introducing version 4 of the _spirit-web-twig_ package.
+
+> Please follow these steps to safely upgrade to Spirit Design System v4 components.
+
+> ℹ️ Don't forget to check the [migration guide of the _spirit-web_ package][migration-guide-web] for general changes in
+> available feature flags, CSS, JavaScript plugins, and other changes that might affect your project.
+
+## Overview
+
+- [Component Changes](#component-changes)
+  - [Button and ButtonLink: `isSquare` prop](#button-and-buttonlink-issquare-prop-renamed-to-issymmetrical)
+
+## Component Changes
+
+### Button and ButtonLink: `isSquare` prop renamed to `isSymmetrical`
+
+Button `isSquare` prop was renamed to `isSymmetrical`.
+
+#### Migration Guide
+
+- `<Button isSquare … />` → `<Button isSymmetrical … />`
+- `<ButtonLink isSquare … />` → `<ButtonLink isSymmetrical … />`
+
+---
+
+Please refer back to this guide or reach out to our team if you encounter any issues during migration.
+
+[migration-guide-web]: https://github.com/lmc-eu/spirit-design-system/blob/main/docs/migrations/web/MIGRATION-v3.md
diff --git a/docs/migrations/web/MIGRATION-v3.md b/docs/migrations/web/MIGRATION-v3.md
new file mode 100644
index 0000000000..98efbd59e4
--- /dev/null
+++ b/docs/migrations/web/MIGRATION-v3.md
@@ -0,0 +1,24 @@
+# Migration Guide
+
+Introducing version 3 of the _spirit-web_ package.
+
+> Please follow these steps to safely upgrade to Spirit Design System v3 components.
+
+## Overview
+
+- [Component Changes](#component-changes)
+  - [Button: renamed modifier `square`](#button-square-modifier-renamed-to-symmetrical)
+
+## Component Changes
+
+### Button: `square` modifier renamed to `symmetrical`
+
+Button `square` modifier was renamed to `symmetrical`.
+
+#### Migration Guide
+
+Instead of using `.Button--square`, use a `.Button--symmetrical`.
+
+- `.Button--square` → `.Button--symmetrical`
+
+---