🐛 fix: Fix docs link

Author: canisminor1990

.dumirc.ts

@@ -2,6 +2,8 @@ import { defineConfig } from 'dumi';
 
 import { homepage } from './package.json';
 
+const isWin = process.platform === 'win32';
+
 const themeConfig = {
   actions: [
     {
@@ -10,7 +12,7 @@ const themeConfig = {
       text: 'Github',
     },
     {
-      link: '/components/action-icon',
+      link: '/guides/intro',
       text: 'Get Started',
       type: 'primary',
     },
@@ -28,11 +30,9 @@ export default defineConfig({
   favicons: [
     'https://registry.npmmirror.com/@lobehub/assets-emoji/1.3.0/files/assets/puzzle-piece.webp',
   ],
-  // locales: [{ id: 'en-US', name: 'English' }],
-  mfsu: {},
+  mfsu: isWin ? undefined : {},
   npmClient: 'pnpm',
   outputPath: 'docs-dist',
-  // ssr: isProduction ? {} : false,
   styles: [
     `html, body { background: transparent;  }
 

.github/workflows/release.yml

@@ -3,9 +3,6 @@ on:
   push:
     branches:
       - master
-      - alpha
-      - beta
-      - rc
 
 jobs:
   test:
@@ -27,8 +24,8 @@ jobs:
       - name: Install deps
         run: pnpm install
 
-      - name: lint
-        run: pnpm run lint && pnpm run doctor
+      - name: CI
+        run: pnpm run ci
 
       - name: Test
         run: pnpm run test

.github/workflows/test.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Install deps
         run: pnpm install
 
-      - name: lint
+      - name: CI
         run: pnpm run ci
 
       - name: Test and coverage

README.md

@@ -1,33 +1,44 @@
 <a name="readme-top"></a>
 
 <div align="center">
-  
+
 <img height="120" src="https://registry.npmmirror.com/@lobehub/assets-logo/1.0.0/files/assets/logo-3d.webp">
 <img height="120" src="https://gw.alipayobjects.com/zos/kitchen/qJ3l3EPsdW/split.svg">
 <img height="120" src="https://registry.npmmirror.com/@lobehub/assets-emoji/1.3.0/files/assets/puzzle-piece.webp">
 
 <h1>Chat Plugin SDK</h1>
 
 SDK for LobeChat funciton calling plugins
-  
+
 [Changelog](./CHANGELOG.md) · [Report Bug][issues-url] · [Request Feature][issues-url]
-  
+
 <!-- SHIELD GROUP -->
 
 [![release][release-shield]][release-url]
 [![releaseDate][release-date-shield]][release-date-url]
 [![ciTest][ci-test-shield]][ci-test-url]
-[![ciRelease][ci-release-shield]][ci-release-url]
-<br/>
+[![ciRelease][ci-release-shield]][ci-release-url] <br/>
 [![contributors][contributors-shield]][contributors-url]
 [![forks][forks-shield]][forks-url]
 [![stargazers][stargazers-shield]][stargazers-url]
 [![issues][issues-shield]][issues-url]
-  
+
 ![](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
 
 </div>
 
+## 🤯 Usage
+
+The LobeChat Plugin SDK assists you in creating exceptional chat plugins for Lobe Chat.
+
+- **SDK Document:** <https://chat-plugin-sdk.lobehub.com>
+
+<div align="right">
+
+[![][back-to-top]](#readme-top)
+
+</div>
+
 ## ⌨️ Local Development
 
 You can use Gitpod for online development:
@@ -49,7 +60,6 @@ $ npm start
 
 </div>
 
-
 ## 🤝 Contributing
 
 <!-- CONTRIBUTION GROUP -->
@@ -78,58 +88,30 @@ $ npm start
 </div>
 
 ---
+
 #### 📝 License
 
 Copyright © 2023 [LobeHub][profile-url]. <br />
-This project is [MIT](./LICENSE) licensed. 
-
+This project is [MIT](./LICENSE) licensed.
 
 <!-- LINK GROUP -->
 
-[profile-url]: https://github.com/lobehub
-[issues-url]: https://github.com/lobehub/chat-plugin-sdk/issues/new/choose
-[gitpod-url]: https://gitpod.io/#https://github.com/lobehub/chat-plugin-sdk
-
-<!-- SHIELD LINK GROUP -->
-
 [back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square
-
-<!-- release -->
-
-[release-shield]: https://img.shields.io/npm/v/@lobehub/chat-plugin-sdk?label=%F0%9F%A4%AF%20NPM
-[release-url]: https://www.npmjs.com/package/@lobehub/chat-plugin-sdk
-
-<!-- releaseDate -->
-
-[release-date-shield]: https://img.shields.io/github/release-date/lobehub/chat-plugin-sdk?style=flat
-[release-date-url]: https://github.com/lobehub/chat-plugin-sdk/releases
-
-<!-- ciTest -->
-
-[ci-test-shield]: https://github.com/lobehub/chat-plugin-sdk/workflows/Test%20CI/badge.svg
-[ci-test-url]: https://github.com/lobehub/chat-plugin-sdk/actions/workflows/test.yml
-
-<!-- ciRelease -->
-
 [ci-release-shield]: https://github.com/lobehub/chat-plugin-sdk/workflows/Release%20CI/badge.svg
 [ci-release-url]: https://github.com/lobehub/chat-plugin-sdk/actions?query=workflow%3ARelease%20CI
-
-<!-- contributors -->
-
+[ci-test-shield]: https://github.com/lobehub/chat-plugin-sdk/workflows/Test%20CI/badge.svg
+[ci-test-url]: https://github.com/lobehub/chat-plugin-sdk/actions/workflows/test.yml
 [contributors-shield]: https://img.shields.io/github/contributors/lobehub/chat-plugin-sdk.svg?style=flat
 [contributors-url]: https://github.com/lobehub/chat-plugin-sdk/graphs/contributors
-
-<!-- forks -->
-
 [forks-shield]: https://img.shields.io/github/forks/lobehub/chat-plugin-sdk.svg?style=flat
 [forks-url]: https://github.com/lobehub/chat-plugin-sdk/network/members
-
-<!-- stargazers -->
-
-[stargazers-shield]: https://img.shields.io/github/stars/lobehub/chat-plugin-sdk.svg?style=flat
-[stargazers-url]: https://github.com/lobehub/chat-plugin-sdk/stargazers
-
-<!-- issues -->
-
+[gitpod-url]: https://gitpod.io/#https://github.com/lobehub/chat-plugin-sdk
 [issues-shield]: https://img.shields.io/github/issues/lobehub/chat-plugin-sdk.svg?style=flat
 [issues-url]: https://img.shields.io/github/issues/lobehub/chat-plugin-sdk.svg?style=flat
+[profile-url]: https://github.com/lobehub
+[release-date-shield]: https://img.shields.io/github/release-date/lobehub/chat-plugin-sdk?style=flat
+[release-date-url]: https://github.com/lobehub/chat-plugin-sdk/releases
+[release-shield]: https://img.shields.io/npm/v/@lobehub/chat-plugin-sdk?label=%F0%9F%A4%AF%20NPM
+[release-url]: https://www.npmjs.com/package/@lobehub/chat-plugin-sdk
+[stargazers-shield]: https://img.shields.io/github/stars/lobehub/chat-plugin-sdk.svg?style=flat
+[stargazers-url]: https://github.com/lobehub/chat-plugin-sdk/stargazers

package.json

@@ -33,7 +33,7 @@
   "scripts": {
     "build": "father build && npm run build:client",
     "build:client": "tsc client.ts --declaration",
-    "ci": "npm run lint && npm run type-check && npm run test",
+    "ci": "npm run lint && npm run type-check && npm run doctor",
     "dev": "father dev",
     "docs:build": "dumi build",
     "docs:dev": "dumi dev",
@@ -106,7 +106,8 @@
     "vitest": "latest"
   },
   "peerDependencies": {
-    "react": "^18"
+    "react": ">=18",
+    "react-dom": ">=18"
   },
   "publishConfig": {
     "access": "public",

tsconfig.json

@@ -1,20 +1,25 @@
 {
   "compilerOptions": {
-    "strict": true,
-    "declaration": true,
-    "skipLibCheck": true,
-    "esModuleInterop": true,
-    "resolveJsonModule": true,
+    "sourceMap": true,
+    "skipDefaultLibCheck": true,
     "jsx": "react-jsx",
-    "types": ["vitest/globals"],
     "baseUrl": ".",
+    "allowSyntheticDefaultImports": true,
+    "moduleResolution": "node",
+    "forceConsistentCasingInFileNames": true,
+    "noImplicitReturns": true,
+    "noUnusedLocals": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "strict": true,
     "paths": {
       "@@/*": ["example/.dumi/tmp/*"],
       "@/*": ["src/*"],
       "dumi/theme/*": ["example/.dumi/tmp/dumi/theme/*"],
       "chat-plugin-sdk": ["src"],
       "chat-plugin-sdk/*": ["src/*", "*"]
-    }
+    },
+    "types": ["vitest/globals"]
   },
   "include": ["src", "tests", ".dumi/**/*", "typings", "example/.dumirc.ts", "*.ts"]
 }