docs: updates on documents

Added information on project structure

.github/workflows/link-check-all.yml

@@ -0,0 +1,22 @@
+name: Check all links in the repository
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  run:
+    name: Link Check All
+    runs-on: ubuntu-latest
+    env:
+      NODE_OPTIONS: '--max-http-header-size=65536'
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Run Link Check
+        uses: 'iterative/link-check.action@v0.7'
+        with:
+          configFile: './config/config.yml'
+          output: consoleLog

.github/workflows/link-check-deploy.yml

@@ -0,0 +1,51 @@
+name: Check new links against deployment
+
+# This workflow "triggers" and skips on deployment because GitHub Actions /
+# Checks refuses to show the check on deployment_status
+on:
+  - deployment
+  - deployment_status
+
+jobs:
+  run:
+    name: Initialize
+    runs-on: ubuntu-latest
+    if: github.event.deployment.ref != 'master' && github.event.deployment_status.state == 'success'
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - id: build_check
+        uses: LouisBrunner/checks-action@v1.0.0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          name: Report
+          status: queued
+
+      - name: Run Link Check
+        id: check
+        uses: 'iterative/link-check.action@v0.7'
+        with:
+          diff: true
+          configFile: './config/config.yml'
+          rootURL: '${{ github.event.deployment.payload.web_url }}'
+          output: checksAction
+
+      - uses: LouisBrunner/checks-action@v1.0.0
+        if: ${{ success() }}
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          check_id: ${{ steps.build_check.outputs.check_id }}
+          status: completed
+          conclusion: ${{ steps.check.outputs.conclusion }}
+          output: ${{ steps.check.outputs.output }}
+
+      - uses: LouisBrunner/checks-action@v1.0.0
+        if: ${{ failure() }}
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          check_id: ${{ steps.build_check.outputs.check_id }}
+          status: completed
+          conclusion: failure
+          output: >-
+            {"summary": "The Link Check script had an error!"}

.gitignore

@@ -8,6 +8,7 @@ lerna-debug.log*
 
 # BlueJ files
 *.ctxt
+*.iml
 
 # Cache files
 .npm

config/config.yml

@@ -0,0 +1,15 @@
+rootURL: https://github.com/AlexRogalskiy/scala-patterns
+
+fileIncludePatterns: '{.github,content,src}/**/*!(.test).{css,js,jsx,md,tsx,ts,json}'
+
+fileExcludePatternFile: ./config/excluded-files.yml
+linkExcludePatternFile: ./config/excluded-links.yml
+
+linkOptions:
+  '*.wikipedia.org':
+    minTime: 2000
+    maxConcurrent: 1
+
+  '(*.)?github.com':
+    minTime: 1000
+    maxConcurrent: 1

config/excluded-files.yml

@@ -0,0 +1,4 @@
+- 'src/consts.js'
+- '**/*.test.js'
+- 'src/server/**/*'
+- '.github/workflows/**/*'

config/excluded-links.yml

@@ -0,0 +1,19 @@
+- 'http://localhost:8000**'
+- 'http://millionsongdataset.com/pages/getting-dataset/#subset'
+- 'https://marketplace.visualstudio.com/items?itemName=stkb.rewrap'
+- 'https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml'
+- 'https://remote.dvc.org/get-started'
+- 'https://sweedom.us10.list-manage.com/subscribe/post?u=a08bf93caae4063c4e6a351f6&id=24c0ecc49a'
+- 'https://www.meetup.com/San-Francisco-Machine-Learning-Meetup/events/264846847/'
+- 'https://www.reddit.com/r/MachineLearning/comments/bx0apm/d_how_do_you_manage_your_machine_learning/'
+- 'https://www.amazon.com/DevOps-Handbook-World-Class-Reliability-Organizations-ebook/dp/B01M9ASFQ3'
+- '**linkedin.com/in/**'
+- '**linkedin.com/company/**'
+- 'link'
+- '/img/<filename>.gif'
+- '/uploads/images/2020-02-10/image.png'
+- 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html'
+- 'https://github.com/iterative/dvc/releases/download/'
+- 'https://www.kaggle.com/kurianbenoy/introduction-to-data-version-control-dvc'
+- 'https://timheuer.com/blog/skipping-ci-github-actions-workflows/'
+- 'https://www.zazzle.com/t_shirt-235920696568133954'

package.json

@@ -17,6 +17,10 @@
         "license": "license-checker --json > licenses.json",
         "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
         "markdown": "markdown-link-check ./README.md ./SECURITY.md",
+        "link-check": "repo-link-check -c config/config.yml -s filesystem -u",
+        "link-check-diff": "repo-link-check -c config/config.yml",
+        "link-check-dev-server": "repo-link-check -c config/config.yml -r http://localhost:3000",
+        "link-check-exclude": "repo-link-check -c config/config.yml -s filesystem -u only",
         "build-image": "docker build -f Dockerfile --tag scala-patterns .",
         "lint:all": "npm run lint:md && npm run lint:json",
         "format:all": "npm run format && npm run format:md",
@@ -36,7 +40,8 @@
         "remark-lint-code-block-style": "^2.0.1",
         "remark-lint-ordered-list-marker-value": "^2.0.1",
         "remark-preset-davidtheclark": "^0.12.0",
-        "remark-validate-links": "^10.0.2"
+        "remark-validate-links": "^10.0.2",
+        "repo-link-check": "^0.7.1"
     },
     "repository": {
         "type": "git",
@@ -48,7 +53,9 @@
     "engines": {
         "node": ">= 12.x"
     },
-    "keywords": ["java patterns"],
+    "keywords": [
+        "scala patterns"
+    ],
     "maintainers": [
         {
             "name": "Alexander Rogalskiy",