Merge pull request #63 from 8iq/refactor-documentation

refactor documentation
8iq · May 30, 2022 · b7d70ee · b7d70ee
2 parents 60b2727 + afb8041
commit b7d70ee
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 23 deletions.
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -5,7 +5,30 @@
 3. Write tests
 4. Make a pull-request to the core repo
 
-# Project features and feature requests
+## linter
+
+We use [eslint](https://eslint.org) as our linter. It enforces code-style and best-practices
+
+We don't allow bad code into the repo. To ensure this we run [eslint](https://eslint.org) on `CI`.
+
+The configuration for the [eslint](https://eslint.org) is found under `package.json`
+
+**Available CLI-commands:**
+
+ - `yarn lint` lint whole project <- this command runs on CI
+ - `yarn run eslint <directory>` check files in `<directory>`
+ - `yarn run eslint --fix <directory>` check files in `<directory>` and fix them if possible
+
+**Editor integrations:**
+
+[Webstorm integration:](https://plugins.jetbrains.com/plugin/7494-eslint)
+
+[VSCode integration:](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+
+[Other editors](https://eslint.org/docs/user-guide/integrations#editors)
+
+
+# Project features and feature requests.
 
 Features that aren't checked are available to take
 

diff --git a/docs/getting-started-adv.md b/docs/getting-started-adv.md
@@ -233,28 +233,6 @@ node ./bin/run-multiple-apps @app/ex02back @app/ex02front @app/ex03sockeio
 
 Every app should have `multi-app-support.js` file. Check `ex02back`, `ex02front` and `ex02sockio` examples.
 
-## linter
-
-We use [eslint](https://eslint.org) as our linter. It enforces code-style and best-practices
-
-We don't allow bad code into the repo. To ensure this we run [eslint](https://eslint.org) on `CI`.
-
-The configuration for the [eslint](https://eslint.org) is found under `package.json`
-
-**Available CLI-commands:**
-
- - `yarn lint` lint whole project <- this command runs on CI
- - `yarn run eslint <directory>` check files in `<directory>`
- - `yarn run eslint --fix <directory>` check files in `<directory>` and fix them if possible
-
-**Editor integrations:**
-
-[Webstorm integration:](https://plugins.jetbrains.com/plugin/7494-eslint)
-
-[VSCode integration:](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
-
-[Other editors](https://eslint.org/docs/user-guide/integrations#editors)
-
 ## Tips
 
 ### yarn add