Merge branch 'main' into overview

Author: laviniat1996

.cspell.jsonc

@@ -11,20 +11,51 @@
       "path": "resources/dictionaries/custom.txt",
       "addWords": true,
     },
+    {
+      "name": "deny-list",
+      "path": "resources/dictionaries/ban.txt"
+    },
     {
       "name": "tvm-instructions",
       "path": "resources/dictionaries/tvm-instructions.txt"
     }
   ],
   "dictionaries": [
     "main-list",
-    "tvm-instructions"
+    "deny-list",
+    "tvm-instructions",
   ],
   "useGitignore": true,
   "files": [
     "**/*.{md,mdx}",
     "**/*.{js,jsx}",
   ],
+  "minWordLength": 3,
+  "overrides": [
+    // Enable case sensitivity for Markdown and MDX files only
+    {
+      "filename": "**/*.{md,mdx}",
+      "caseSensitive": true
+    },
+    // Do not check for banned words (denylist) in certain files
+    {
+      "filename": "contribute/style-guide*.mdx",
+      "ignoreWords": [
+        "tos",
+        "DOI",
+        "BOC",
+      ],
+      "dictionaries": [
+        "!deny-list"
+      ]
+    },
+    {
+      "filename": "**/api/**/v*",
+      "dictionaries": [
+        "!deny-list"
+      ]
+    },
+  ],
   "ignorePaths": [
     // Some whitepapers
     "foundations/whitepapers/tblkch.mdx",
@@ -49,7 +80,7 @@
     "**/*.svg",
     "**/*.txt",
     "CODEOWNERS",
-    "**/*http-api*",
+    "snippets/tvm-instruction-table.jsx",
   ],
   "ignoreRegExpList": [
     //
@@ -78,7 +109,7 @@
     //
     "=\\s*\".*?\"", // ="..."
     "(?<!\\\\)\\$(?:\\\\.|[^$\\\\])*?\\$", // inline math
-    "/(?<!\\\\)\\$\\$\\r?\\n.*?(?<=\\n)\\$\\$/gms", // block math
+    "/(?<!\\\\)\\$\\$[\\s\\S]*?\\$\\$/g", // block math
     "(?<!\\\\)`.*?`", // inline code
     "/^([ \\t]*```).*([\\s\\S]*?)^\\1$/gmx", // block code
     "^import[ \\t].+$", // import ...

.github/workflows/linter.yml

@@ -2,6 +2,7 @@ name: 💅 Linting suite
 
 env:
   HUSKY: 0
+  NODE_VERSION: 20
 
 on:
   pull_request:
@@ -30,7 +31,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: ${{ env.NODE_VERSION }}
           cache: "npm"
 
       - name: Install dependencies
@@ -62,7 +63,7 @@ jobs:
           echo
           npx remark --no-stdout --quiet --frail --silently-ignore $(echo -e "${ALL_CHANGED_FILES[@]}" | tr '\n' ' ')
 
-      - name: ${{ steps.check-fmt.conclusion == 'failure' && '👀' }} How to fix the formatting? See these suggestions!
+      - name: ${{ steps.check-fmt.conclusion == 'failure' && '👀 How to fix the formatting? See these suggestions!' || '...' }}
         env:
           ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
         if: failure()
@@ -93,7 +94,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: ${{ env.NODE_VERSION }}
           cache: "npm"
 
       - name: Install dependencies
@@ -107,3 +108,41 @@ jobs:
         with:
           check_dot_files: explicit
           suggestions: true
+
+  redirects-check:
+    name: "Redirects"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: "npm"
+
+      - name: Install dependencies
+        run: |
+          corepack enable
+          npm ci
+
+      - name: Check uniqueness of redirect sources in docs.json
+        if: ${{ !cancelled() }}
+        run: node scripts/check-redirects.mjs unique
+
+      - name: Check existence of redirect destinations in docs.json
+        if: ${{ !cancelled() }}
+        run: node scripts/check-redirects.mjs exist
+
+      - name: Check redirects against the previous TON Documentation
+        if: ${{ !cancelled() }}
+        run: node scripts/check-redirects.mjs previous
+
+      # NOTE: Re-enable before the release,
+      #       see: https://github.com/ton-org/docs/issues/39
+      # - name: Check redirects against the upstream docs.json structure
+      #   if: ${{ !cancelled() }}
+      #   run: node scripts/check-redirects.mjs upstream