Fix docs and improve ci (#182)

.github/workflows/check-format.yml

@@ -1,9 +1,21 @@
 name: format
 
 on:
-  pull_request:
   push:
     branches: [main]
+    paths:
+      - .clang-format
+      - "include/**"
+      - "src/**"
+      - "tests/**"
+
+  pull_request:
+    branches: [main]
+    paths:
+      - .clang-format
+      - "include/**"
+      - "src/**"
+      - "tests/**"
 
 jobs:
   check:

.github/workflows/cmake.yml

@@ -3,18 +3,21 @@ name: cmake
 on:
   push:
     branches: [main]
+    paths:
+      - ".github/workflows/cmake.yml"
+      - "include/**"
+      - "src/**"
+      - "tests/**"
+      - "CMakeLists.txt"
+
   pull_request:
     branches: [main]
-    paths-ignore:
+    paths:
-      - "docs"
+      - ".github/workflows/cmake.yml"
-      - "scripts"
+      - "include/**"
-      - ".clang-format"
+      - "src/**"
-      - ".clangd"
+      - "tests/**"
-      - ".gitignore"
+      - "CMakeLists.txt"
-      - "LICENSE"
-      - "README.md"
-      - ".github/workflows/xmake.yml"
-      - "xmake.lua"
 
 jobs:
   build:

.github/workflows/xmake.yml

@@ -3,20 +3,21 @@ name: xmake
 on:
   push:
     branches: [main]
+    paths:
+      - ".github/workflows/xmake.yml"
+      - "include/**"
+      - "src/**"
+      - "tests/**"
+      - "xmake.lua"
+
   pull_request:
     branches: [main]
-    paths-ignore:
+    paths:
-      - "docs"
+      - ".github/workflows/xmake.yml"
-      - "scripts"
+      - "include/**"
-      - ".clang-format"
+      - "src/**"
-      - ".clangd"
+      - "tests/**"
-      - ".gitignore"
+      - "xmake.lua"
-      - "LICENSE"
-      - "README.md"
-      - ".github/workflows/cmake.yml"
-      - "CMakeLists.txt"
-      - "CMakePresets.json"
-      - "cmake"
 
 jobs:
   linux:

docs/.vitepress/config.ts

@@ -18,17 +18,16 @@ export default defineConfig({
     nav: [
       { text: 'Home', link: '/' },
     ],
-
     sidebar: {
       "/zh/": [
-        genSidebar('zh/design', { title: 'Design' }),
+        genSidebar('zh', 'design', { title: 'Design' }),
-        genSidebar('zh/dev', { title: 'Development' }),
+        genSidebar('zh', 'dev', { title: 'Development' }),
-        genSidebar('zh/guide', { title: 'Guide' }),
+        genSidebar('zh', 'guide', { title: 'Guide' }),
       ],
       "/": [
-        genSidebar('en/design', { title: 'Design' }),
+        genSidebar('en', 'design', { title: 'Design' }),
-        genSidebar('en/dev', { title: 'Development' }),
+        genSidebar('en', 'dev', { title: 'Development' }),
-        genSidebar('en/guide', { title: 'Guide' }),
+        genSidebar('en', 'guide', { title: 'Guide' }),
       ],
     },
     socialLinks: [

docs/.vitepress/theme/sidebar.ts

@@ -3,6 +3,7 @@ import path from 'path'
 import { DefaultTheme } from 'vitepress'
 
 export const genSidebar = (
+    lang: string,
     dirPath: string,
     options: {
         title: string
@@ -10,7 +11,7 @@ export const genSidebar = (
         ignore?: string[]
     }
 ): DefaultTheme.SidebarItem => {
-    const sidebarPath = path.resolve(process.cwd(), dirPath)
+    const sidebarPath = path.resolve(process.cwd(), lang, dirPath)
     const ignore = options.ignore || ['index.md']
 
     const files = fs
@@ -22,9 +23,17 @@ export const genSidebar = (
         const match = content.match(/^#\s+(.*)/)
         const title = match ? match[1] : file.replace('.md', '')
 
+        let prefix = '/';
+        if (lang != 'en') {
+            prefix += lang;
+            prefix += '/';
+        }
+
         return {
             text: title,
-            link: `/${dirPath}/${file.replace('.md', '')}`
+            /// Make sure link for en is actually root, beacuse Github Pages
+            /// doesn't support redirect url.
+            link: `${prefix}${dirPath}/${file.replace('.md', '')}`
         }
     })
 

docs/en/index.md

@@ -8,13 +8,13 @@ hero:
   actions:
     - theme: brand
       text: What is clice?
-      link: /en/guide/what-is-clice
+      link: /guide/what-is-clice
     - theme: alt
       text: Quick Start
-      link: /en/guide/quick-start
+      link: /guide/quick-start
     - theme: alt
       text: Contribution
-      link: /en/dev/contribution
+      link: /dev/contribution
   image:
       src: /image.png
       alt: clice