Merge remote-tracking branch 'origin/main' into trace-rework

Author: Shvandre

.cspell.jsonc

@@ -7,28 +7,105 @@
   "language": "en-US",
   "dictionaryDefinitions": [
     {
+      // Allowed words
       "name": "main-list",
       "path": "resources/dictionaries/custom.txt",
       "addWords": true,
     },
+    {
+      // Banned words with no clear or correct replacements
+      // For a few words with those, see the flagWords property later in this file
+      "name": "deny-list",
+      "path": "resources/dictionaries/ban.txt"
+    },
+    {
+      "name": "2lw-deny-list",
+      "path": "resources/dictionaries/two-letter-words-ban.txt"
+    },
     {
       "name": "tvm-instructions",
       "path": "resources/dictionaries/tvm-instructions.txt"
     }
   ],
   "dictionaries": [
     "main-list",
-    "tvm-instructions"
+    "deny-list",
+    "2lw-deny-list",
+    "tvm-instructions",
   ],
   "useGitignore": true,
   "files": [
     "**/*.{md,mdx}",
-    "**/*.{js,jsx}",
+    "**/*.{js,jsx,mjs}",
+  ],
+  "minWordLength": 3,
+  "overrides": [
+    // Enable case sensitivity for Markdown and MDX files only
+    {
+      "filename": "**/*.{md,mdx}",
+      "caseSensitive": true,
+      // Known incorrect spellings and correct suggestions
+      "flagWords": [
+        "AccountChain->accountchain",
+        "BaseChain->basechain",
+        "boc->BoC",
+        "BOC->BoC",
+        "Github->GitHub",
+        "MasterChain->masterchain",
+        "ShardChain->shardchain",
+        "Toncenter->TON Center",
+        "toncoins->Toncoin",
+        "Toncoins->Toncoin",
+        "WorkChain->workchain",
+        "zkProof->ZK-proof",
+        "zkProofs->ZK-proofs",
+      ],
+    },
+    // Do not check for banned words (denylists or flagWords) in certain files
+    {
+      "filename": "contribute/style-guide*.mdx",
+      "ignoreWords": [
+        "tos",
+        "DOI",
+        "boc",
+        "BOC",
+      ],
+      "ignoreRegExpList": [
+        "\\b[tT]on[a-zA-Z]+\\b", // ton or Ton-prefixed words
+        "\\b[a-zA-Z]+Chain\\b", // Chain-suffixed words
+      ],
+      "dictionaries": [
+        "!deny-list", // turns off the dictionary
+        "!2lw-deny-list", // turns off the dictionary
+      ]
+    },
+    {
+      "filename": "**/api/**/*.{json,yml,yaml}",
+      "ignoreWords": [
+        "smc",
+      ],
+      "dictionaries": [
+        "!deny-list", // turns off the dictionary
+        "!2lw-deny-list", // turns off the dictionary
+      ]
+    },
+    {
+      "filename": "**/*.{js,jsx,mjs}",
+      "ignoreWords": [
+        "Dests",
+      ],
+      "dictionaries": [
+        "!deny-list", // turns off the dictionary
+        "!2lw-deny-list", // turns off the dictionary
+      ]
+    }
   ],
   "ignorePaths": [
     // Some whitepapers
     "foundations/whitepapers/tblkch.mdx",
     "foundations/whitepapers/ton.mdx",
+    "foundations/whitepapers/tvm.mdx",
+    "languages/fift/whitepaper.mdx",
     // Generated files
     "tvm/instructions.mdx",
     // Binaries
@@ -44,12 +121,14 @@
     "**/*.tolk",
     "**/*.py*",
     "**/*.{ts,tsx}",
+    "**/*.css",
     // Miscellaneous
     "**/*.git*",
     "**/*.svg",
     "**/*.txt",
     "CODEOWNERS",
-    "**/*http-api*",
+    "LICENSE-*",
+    "snippets/tvm-instruction-table.jsx",
   ],
   "ignoreRegExpList": [
     //
@@ -78,12 +157,12 @@
     //
     "=\\s*\".*?\"", // ="..."
     "(?<!\\\\)\\$(?:\\\\.|[^$\\\\])*?\\$", // inline math
-    "/(?<!\\\\)\\$\\$\\r?\\n.*?(?<=\\n)\\$\\$/gms", // block math
+    "/(?<!\\\\)\\$\\$[\\s\\S]*?\\$\\$/g", // block math
+    "(?<!\\\\)``.*?``", // inline code with double backticks
     "(?<!\\\\)`.*?`", // inline code
     "/^([ \\t]*```).*([\\s\\S]*?)^\\1$/gmx", // block code
     "^import[ \\t].+$", // import ...
     "/^export[ \\t].+?(?=\\r?\\n\\r?\\n)/gms", // export ...
     "(?<!\\\\)\\{(?:[^{}]|\\{(?:[^{}]|\\{[^{}]*\\})*\\})*\\}", // jsx expressions in {}
-    "/\\bton-?[a-z]+/gi", // ton-prefixed product names
   ],
 }

.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
@@ -55,20 +56,20 @@ jobs:
             echo -e '\nNo such files affected!'
             exit 0
           fi
-          echo -e '\nChecking formatting on the following MDX and Markdown files affected by this PR:\n'
+          echo -e '\nChecking formatting of the following MDX and Markdown files affected by this PR:\n'
           for file in ${ALL_CHANGED_FILES}; do
             echo "- $file"
           done
           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()
         run: |
           # Preparations
-          FILES="$(echo -e "${ALL_CHANGED_FILES[@]}" | tr '\n' ' ')"
+          FILES="$(echo -e "${ALL_CHANGED_FILES[@]}" | tr '\n' ' ' | sed 's/.*/\"&\"/')"
           BODY="{\"body\":\"To fix the **formatting** issues:\n\n1. Install necessary dependencies: \`npm ci\`\n2. Then, run this command:\n\`\`\`shell\nnpx remark -o --silent --silently-ignore ${FILES}\n\`\`\`\"}"
           # Comment on the PR
           curl -s -o /dev/null -L -X POST \
@@ -87,13 +88,13 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
+        # The fetch-depth is not set to 0 to prevent the cspell-action
+        # from misfiring on files that are in main but not on this PR branch
 
       - 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,74 @@ jobs:
         with:
           check_dot_files: explicit
           suggestions: true
+          config: ".cspell.jsonc"
+
+  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
+
+  navigation-check:
+    name: "Navigation"
+    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 navigation paths in docs.json
+        if: ${{ !cancelled() }}
+        run: node scripts/check-navigation.mjs unique
+
+      - name: Check existence of navigation .mdx pages in docs.json
+        if: ${{ !cancelled() }}
+        run: node scripts/check-navigation.mjs exist
+
+      - name: Check coverage of .mdx pages by docs.json
+        if: ${{ !cancelled() }}
+        run: node scripts/check-navigation.mjs cover

.prettierignore

@@ -1,3 +1,5 @@
 *.mdx
 /ecosystem/api/toncenter/v2/
 /ecosystem/api/toncenter/v3/
+/ecosystem/api/toncenter/smc-index/
+/LICENSE*

.remarkignore

@@ -8,10 +8,12 @@ node_modules/
 /foundations/whitepapers/ton.mdx
 /foundations/whitepapers/tvm.mdx
 
-# Ignore root index.mdx file
+# Ignore some root files
 /index.mdx
+/LICENSE*
 
 # Ignore generated files and directories
 /tvm/instructions.mdx
 /ecosystem/api/toncenter/v2/
 /ecosystem/api/toncenter/v3/
+/ecosystem/api/toncenter/smc-index/

LICENSE-code

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 TON Studio and others
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.