Update documentation

Igorkowalski94 · Jul 29, 2024 · 9c974c7 · 9c974c7
1 parent 48f755e
commit 9c974c7
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 6 deletions.
diff --git a/documentation/project-structure-folder-structure.md b/documentation/project-structure-folder-structure.md
@@ -15,7 +15,8 @@ Enforce rules on folder structure to keep your repository consistent, orderly an
 
 [**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
 
-Become part of the community! Leave a ⭐ and share the link with your friends.<br>
+Become part of the community!<br>
+Leave a ⭐ and share the link with your friends.<br>
 If you have any questions **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/discussions)**, issues / an idea for a new functionality **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/issues/new/choose)**.
 
 ### Documentation:
@@ -120,6 +121,9 @@ Add the following lines to **`.eslintrc`**.
 
 Add the following lines to **`.eslintrc`**.
 
+> [!CAUTION]
+> Remember to remove comments from the JSON file. Otherwise the configuration will be incorrect.
+
 ```jsonc
 {
     "plugins": ["project-structure"],
@@ -136,9 +140,6 @@ Add the following lines to **`.eslintrc`**.
 
 Create a **`folderStructure.json`** or **`folderStructure.yaml`** in the root of your project.<br>
 
-> [!CAUTION]
-> Remember to remove comments from the JSON file. Otherwise the configuration will be incorrect.
-
 #### Simple example for the structure below:
 
 ```

diff --git a/documentation/project-structure-independent-modules.md b/documentation/project-structure-independent-modules.md
@@ -15,7 +15,8 @@ Get rid of dependencies between modules and create truly independent functionali
 
 [**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
 
-Become part of the community! Leave a ⭐ and share the link with your friends.<br>
+Become part of the community!<br>
+Leave a ⭐ and share the link with your friends.<br>
 If you have any questions **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/discussions)**, issues / an idea for a new functionality **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/issues/new/choose)**.
 
 ### Documentation:
@@ -60,6 +61,9 @@ npm i --dev eslint-plugin-independent-modules
 
 Add the following lines to **`.eslintrc`**.
 
+> [!CAUTION]
+> Remember to remove comments from the JSON file. Otherwise the configuration will be incorrect.
+
 ```jsonc
 {
     "plugins": ["project-structure"],

diff --git a/documentation/project-structure-naming-rules.md b/documentation/project-structure-naming-rules.md
@@ -15,7 +15,8 @@ Enforce naming rules.
 
 [**Playground**](https://github.com/Igorkowalski94/eslint-plugin-project-structure-playground) for eslint-plugin-project-structure rules.
 
-Become part of the community! Leave a ⭐ and share the link with your friends.<br>
+Become part of the community!<br>
+Leave a ⭐ and share the link with your friends.<br>
 If you have any questions **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/discussions)**, issues / an idea for a new functionality **[click here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/issues/new/choose)**.
 
 ### Documentation: