feat: update zh-hant

Author: xiaoyu2er

.github/actions/update-search-index/action.yml

@@ -4,11 +4,8 @@ inputs:
   locale:
     description: "Locale to update (e.g., 'en' or 'zh-hans')"
     required: true
-  orama_private_api_key_en:
-    description: "Orama Private API Key for EN"
-    required: true
-  orama_private_api_key_zh_hans:
-    description: "Orama Private API Key for ZH-HANS"
+  orama_private_api_key:
+    description: "Orama Private API Key"
     required: true
 runs:
   using: "composite"
@@ -26,5 +23,4 @@ runs:
       run: pnpm run update-search-index
       env:
         LOCALE: "${{ inputs.locale }}"
-        ORAMA_PRIVATE_API_KEY_EN: ${{ inputs.orama_private_api_key_en }}
-        ORAMA_PRIVATE_API_KEY_ZH_HANS: ${{ inputs.orama_private_api_key_zh_hans }}
+        ORAMA_PRIVATE_API_KEY: ${{ inputs.orama_private_api_key }}

.github/actions/vercel-deploy/action.yml

@@ -30,6 +30,14 @@ runs:
         VERCEL_PROJECT_ID: ${{ inputs.vercel_project_id }}
         VERCEL_ORG_ID: ${{ inputs.vercel_org_id }}
       shell: bash
+    - name: Echo Vercel Environment File
+      run: |
+        ls -l .vercel/.env*
+        for f in .vercel/.env*; do
+          echo "\n----- $f -----"
+          cat "$f"
+        done
+      shell: bash
     - name: Build Project Artifacts
       run: npx vercel build ${{ inputs.prodFlag }} --token=${{ inputs.vercel_token }}
       env:

.github/workflows/prerelease.yml

@@ -19,13 +19,13 @@ jobs:
     strategy:
       matrix:
         include:
-          - name: Deploy EN
-            locale: EN
+          - locale: en
             secret_project_id: VERCEL_PROJECT_EN_ID
-          - name: Deploy ZH-HANS
-            locale: ZH-HANS
+          - locale: zh-hans
             secret_project_id: VERCEL_PROJECT_ZH_HANS_ID
-    name: ${{ matrix.name }}
+          - locale: zh-hant
+            secret_project_id: VERCEL_PROJECT_ZH_HANT_ID
+    name: Deploy ${{ matrix.locale }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
@@ -38,7 +38,6 @@ jobs:
         uses: ./.github/actions/vercel-deploy
         with:
           environment: preview
-          prodFlag: ""
           vercel_project_id: ${{ secrets[matrix.secret_project_id] }}
           vercel_org_id: ${{ secrets.VERCEL_ORG_ID }}
           vercel_token: ${{ secrets.VERCEL_TOKEN }}

.github/workflows/release.yml

@@ -12,13 +12,16 @@ jobs:
     strategy:
       matrix:
         include:
-          - name: Deploy EN
-            locale: en
+          - locale: en
             secret_project_id: VERCEL_PROJECT_EN_ID
-          - name: Deploy ZH-HANS
-            locale: zh-hans
+            orama_private_api_key: ORAMA_PRIVATE_API_KEY_EN
+          - locale: zh-hans
             secret_project_id: VERCEL_PROJECT_ZH_HANS_ID
-    name: ${{ matrix.name }}
+            orama_private_api_key: ORAMA_PRIVATE_API_KEY_ZH_HANS
+          - locale: zh-hant
+            secret_project_id: VERCEL_PROJECT_ZH_HANT_ID
+            orama_private_api_key: ORAMA_PRIVATE_API_KEY_ZH_HANT
+    name: Deploy ${{ matrix.locale }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
@@ -39,5 +42,4 @@ jobs:
         uses: ./.github/actions/update-search-index
         with:
           locale: ${{ matrix.locale }}
-          orama_private_api_key_en: ${{ secrets.ORAMA_PRIVATE_API_KEY_EN }}
-          orama_private_api_key_zh_hans: ${{ secrets.ORAMA_PRIVATE_API_KEY_ZH_HANS }}
+          orama_private_api_key: ${{ secrets[matrix.orama_private_api_key] }}

README.md

@@ -47,7 +47,7 @@ pnpm dev
 This project includes a custom translation utility that can translate the Next.js documentation into multiple languages. Currently, it supports:
 
 - English (source)
-- Simplified Chinese (zh-Hans)
+- Simplified Chinese (zh-hans)
 - More languages can be added in the translation configuration
 
 Documentation content is stored in the `apps/docs/content` directory:

apps/docs/scripts/update-orama-index.mts

@@ -7,10 +7,17 @@ import type { Locale } from 'next-intl';
 import { sync } from '../src/lib/orama/orama-cloud';
 
 export async function updateSearchIndexes(): Promise<void> {
-  const { locale, privateKey, index } =
-    ORAMA_CONFIGS_MAP[process.env.LOCALE as Locale];
+  if (!process.env.ORAMA_PRIVATE_API_KEY) {
+    console.warn(
+      'ORAMA_PRIVATE_API_KEY is not set. Skipping Orama index update.',
+    );
+    return;
+  }
+  const { locale, index } = ORAMA_CONFIGS_MAP[process.env.LOCALE as Locale];
 
-  const manager = new CloudManager({ api_key: privateKey });
+  const manager = new CloudManager({
+    api_key: process.env.ORAMA_PRIVATE_API_KEY || '',
+  });
   // Get all .body files in the static directory
   const staticDir = path.join('.next/server/app/static');
   let allRecords: OramaDocument[] = [];

apps/docs/scripts/update-search-index.mts

@@ -1,6 +1,8 @@
 import env from '@next/env';
 env.loadEnvConfig(process.cwd());
 
+console.log(process.env);
+
 import { updateSearchIndexes } from './update-orama-index.mjs';
 
 async function main() {

apps/docs/src/lib/orama/config.ts

@@ -2,7 +2,6 @@ import type { Locale } from 'next-intl';
 
 const ORAMA_EN_CONFIG = {
   locale: 'en',
-  privateKey: process.env.ORAMA_PRIVATE_API_KEY_EN || '',
   apiKey: '4DujbZrvGuklBRFcZBtegX3fV1lzNXnU',
   index: 'vuywlowcbl1w3s2jtvq5ysxl',
   endpoint: 'https://cloud.orama.run/v1/indexes/en-ai00ky',
@@ -12,15 +11,22 @@ type ORAMA_EN_CONFIG = typeof ORAMA_EN_CONFIG;
 
 const OORAMA_ZH_HANS_CONFIG = {
   locale: 'zh-hans',
-  privateKey: process.env.ORAMA_PRIVATE_API_KEY_ZH_HANS || '',
   apiKey: '6nEUS4tyXiajWxZ8qMEQMzzLoOYTuLSk',
   index: 'vcwl00bwd64h3pa8yq8x107y',
   endpoint: 'https://cloud.orama.run/v1/indexes/zh-hans-js5ujm',
 };
 
+const OORAMA_ZH_HANT_CONFIG = {
+  locale: 'zh-hant',
+  apiKey: 'm2Wdhf6R37fKAhXNDufzbegTuQdz6aqf',
+  index: 'l4wtdj6zo3gpv432pmf4s98g',
+  endpoint: 'https://cloud.orama.run/v1/indexes/zh-hant-nvys3a',
+};
+
 export const ORAMA_CONFIGS = [ORAMA_EN_CONFIG, OORAMA_ZH_HANS_CONFIG] as const;
 
 export const ORAMA_CONFIGS_MAP: Record<Locale, ORAMA_EN_CONFIG> = {
   en: ORAMA_EN_CONFIG,
   'zh-hans': OORAMA_ZH_HANS_CONFIG,
+  'zh-hant': OORAMA_ZH_HANT_CONFIG,
 } as const;

apps/docs/translation.config.mjs

@@ -1,6 +1,6 @@
 export default {
   langs: {
-    'zh-Hans': {
+    'zh-hans': {
       name: 'Simplified Chinese',
       // 翻译规则和指南
       guide: `
@@ -13,19 +13,19 @@ export default {
       // 格式: 'English term': '中文翻译'
       terms: {},
     },
-    //     'zh-Hant': {
-    //       name: 'Traditional Chinese',
-    //       // 翻譯規則和指南
-    //       guide: `
-    //     - For technical terms that should not be fully translated, use the format: "繁體中文翻譯 (English term)"
-    //       Example: "伺服器渲染 (SSR)" instead of just "SSR" or just "伺服器渲染"
-    //     - Add a space between Chinese characters and English words/symbols to improve readability
-    //     - Maintain consistent translations for common terms across the entire document
-    // `,
-    //       // 常見技術術語翻譯詞典
-    //       // 格式: 'English term': '繁體中文翻譯'
-    //       terms: {},
-    //     },
+    'zh-hant': {
+      name: 'Traditional Chinese',
+      // 翻譯規則和指南
+      guide: `
+        - For technical terms that should not be fully translated, use the format: "繁體中文翻譯 (English term)"
+          Example: "伺服器渲染 (SSR)" instead of just "SSR" or just "伺服器渲染"
+        - Add a space between Chinese characters and English words/symbols to improve readability
+        - Maintain consistent translations for common terms across the entire document
+    `,
+      // 常見技術術語翻譯詞典
+      // 格式: 'English term': '繁體中文翻譯'
+      terms: {},
+    },
     //     ja: {
     //       name: 'Japanese',
     //       guide: `