Enable twoslash

Author: tarrencev

.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint-and-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+          run_install: false
+
+      - name: Get pnpm store directory
+        shell: bash
+        run: echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - name: Setup pnpm cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Validate Twoslash code blocks
+        run: pnpm validate-twoslash

CLAUDE.md

@@ -47,4 +47,15 @@ The documentation covers three main products:
 - Key dependencies: React 18, Starknet libraries, Cartridge connector
 - Vocs alpha version (1.0.0-alpha.55)
 
+### TypeScript Twoslash Integration
+The documentation site supports TypeScript Twoslash for enhanced code blocks that provide:
+- Type information on hover
+- IntelliSense-like features
+- Compile-time error checking in documentation
+
+To use Twoslash in code blocks, add `twoslash` to the language identifier:
+```typescript twoslash
+// Your TypeScript code here with full type checking
+```
+
 When editing content, maintain the existing markdown structure and follow the established sidebar navigation patterns in `vocs.config.ts`.

package.json

@@ -5,22 +5,26 @@
   "scripts": {
     "dev": "vocs dev",
     "build": "vocs build",
-    "preview": "vocs preview"
+    "preview": "vocs preview",
+    "validate-twoslash": "node scripts/validate-twoslash.js"
   },
   "dependencies": {
-    "@cartridge/connector": "^0.3.46",
-    "@starknet-react/chains": "^0.1.7",
+    "@cartridge/connector": "^0.8.0",
+    "@starknet-react/chains": "^3.1.3",
     "@starknet-react/core": "^3.5.0",
-    "@types/react": "^18.3.12",
-    "get-starknet-core": "^3.3.4",
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1",
-    "react-router-dom": "^6.28.0",
-    "starknet": "^6.21.0",
-    "vocs": "1.0.0-alpha.55",
+    "@types/react": "^19",
+    "react": "^19",
+    "react-dom": "^19",
+    "react-router-dom": "^7.6",
+    "starknet": "^7.6",
+    "vocs": "1.0.12",
     "yaml": "^2.6.0"
   },
   "devDependencies": {
+    "@cartridge/controller": "0.8.0",
+    "@shikijs/twoslash": "^3.7.0",
+    "glob": "^11.0.3",
+    "typescript": "^5.8.3",
     "vite-plugin-svgr": "^4.3.0"
   },
   "packageManager": "pnpm@9.12.1+sha512.e5a7e52a4183a02d5931057f7a0dbff9d5e9ce3161e33fa68ae392125b79282a8a8a470a51dfc8a0ed86221442eb2fb57019b0990ed24fab519bf0e1bc5ccfc4"