feat(ci): add docs.json bi-directional navigation structure checks (#1247)

Author: novusnota

.cspell.jsonc

@@ -57,6 +57,8 @@
         "toncoins->Toncoin",
         "Toncoins->Toncoin",
         "WorkChain->workchain",
+        "zkProof->ZK-proof",
+        "zkProofs->ZK-proofs",
       ],
     },
     // Do not check for banned words (denylists or flagWords) in certain files
@@ -119,6 +121,7 @@
     "**/*.tolk",
     "**/*.py*",
     "**/*.{ts,tsx}",
+    "**/*.css",
     // Miscellaneous
     "**/*.git*",
     "**/*.svg",

.github/workflows/linter.yml

@@ -56,7 +56,7 @@ 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
@@ -69,7 +69,7 @@ jobs:
         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 \
@@ -147,3 +147,35 @@ jobs:
       # - 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

README.md

@@ -43,9 +43,9 @@ npm run spell:some <FILES...>
 
 The dictionaries (or vocabularies) for custom words are placed under `resources/dictionaries`. There, each dictionary describes additional allowed or invalid entries.
 
-The primary dictionary is `resources/dictionaries/custom.txt` — extend it in case a word exists but was flagged by CSpell as invalid, or in cases where the word does not exist and shall be prohibited. For the latter, use the `!` prefix when adding words.
+The primary dictionary is `resources/dictionaries/custom.txt` — extend it in case a word exists in American English but was flagged by CSpell as invalid, or in cases where the word does not exist and shall be prohibited. For the latter, add words to `resources/dictionaries/ban.txt` with the `!` prefix when there are no clear correct replacements.
 
-If an existing two-letter word was flagged as forbidden, remove it from the `resources/dictionaries/two-letter-words-ban.txt` file.
+If an existing two-letter word was flagged as forbidden, remove it from the `resources/dictionaries/two-letter-words-ban.txt` file. However, if a word happened to be a part of a bigger word, e.g., `CL` in `OpenCL`, do not ban it and instead add the bigger word to the primary dictionary in `resources/dictionaries/custom.txt`.
 
 See more: [CSpell docs on custom dictionaries](https://cspell.org/docs/dictionaries/custom-dictionaries).
 

contract-dev/fee-management.mdx

@@ -6,7 +6,7 @@ span.method-nav-pill {
   /* or 3rem */
 }
 
-/* Prevent work breaks in inline code items in tables */
+/* Prevent word breaks in inline code items in tables */
 td>code,
 td>em>code,
 td>strong>code,