docs: move doc site dir to website dir

.eslintignore

@@ -8,5 +8,5 @@ packages/preset-icons/src/collections.json
 packages/eslint-plugin/fixtures
 bench/source/gen*.js
 !.vitepress
-docs/.vitepress/cache/deps/*.*
+website/.vitepress/cache/deps/*.*
 test/cases

.eslintrc

@@ -33,7 +33,7 @@
       }
     },
     {
-      "files": ["docs/**/*.*"],
+      "files": ["website/**/*.*"],
       "rules": {
         "@typescript-eslint/no-require-imports": "off"
       }

.gitignore

@@ -21,14 +21,14 @@ result.json
 .eslintcache
 vite.config.ts.timestamp-*
 
-docs/.docusaurus
-docs/netlifyDeployPreview/*
-docs/changelog
-!docs/netlifyDeployPreview/index.html
-!docs/netlifyDeployPreview/_redirects
+website/.docusaurus
+website/netlifyDeployPreview/*
+website/changelog
+!website/netlifyDeployPreview/index.html
+!website/netlifyDeployPreview/_redirects
 
-docs/_dogfooding/_swizzle_theme_tests
+website/_dogfooding/_swizzle_theme_tests
 
-docs/i18n/**/*
+website/i18n/**/*
 
 .gpt-runner

README.md

@@ -1,9 +1,9 @@
 <div align="center">
-<img src="./docs/static/img/svg/logo-text.svg" alt="icon"/>
+<img src="./website/static/img/svg/logo-text.svg" alt="icon"/>
 
 <h1 align="center">GPT Runner</h1>
 
-English / [简体中文](./README_CN.md)
+English / [简体中文](https://github.com/nicepkg/gpt-runner/tree/main/README_CN.md)
 
 Manage ai presets. Chat with your code files. Revolutionize Your Team's Collaboration and Efficiency!
 
@@ -13,15 +13,15 @@ Manage ai presets. Chat with your code files. Revolutionize Your Team's Collabor
 [![Web][web-image]][web-url]
 [![VSCode][vscode-image]][vscode-url]
 
-[CLI](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-cli/) / [Web App](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-web/) / [VSCode Extension](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-vscode/) / [Issues](https://github.com/nicepkg/gpt-runner/issues) / [Buy Me a Coffee](https://bmc.link/jinmingyang)
+[CLI](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-cli/) / [Web Page](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-web/) / [VSCode Extension](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-vscode/) / [Issues](https://github.com/nicepkg/gpt-runner/issues) / [Buy Me a Coffee](https://bmc.link/jinmingyang)
 
 [终端工具](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-cli/) / [网页版](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-web/) / [VSCode 扩展](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-vscode/) / [反馈](https://github.com/Yidadaa/ChatGPT-Next-Web/issues) / [打赏开发者](https://github.com/nicepkg/gpt-runner/assets/35005637/98a4962a-8a2e-4177-8781-1e1ee886ecdc)
 
-[cli-url]: ./packages/gpt-runner-cli/
+[cli-url]: https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-cli/
 [cli-image]: https://img.shields.io/badge/CLI-Node.js-green?logo=node.js
-[web-url]: ./packages/gpt-runner-web/
+[web-url]: https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-web/
 [web-image]: https://img.shields.io/badge/Web-React-blue?logo=react
-[vscode-url]: ./packages/gpt-runner-vscode/
+[vscode-url]: https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-vscode/
 [vscode-image]: https://img.shields.io/badge/VSCode-Extension-blue?logo=visualstudiocode
 
 </div>
@@ -29,7 +29,7 @@ Manage ai presets. Chat with your code files. Revolutionize Your Team's Collabor
 ## Features
 
 - **CLI & IDE Integration:** GPT-Runner offers a powerful command-line interface and IDE extension for AI robot presets through `xxx.gpt.md` files, enabling efficient AI workflows across various IDEs.
-- **Chat with Your Files:** GPT-Runner allows you to chat with your code files. you can selected some files or folders, and then chat with them.
+- **Chat with Your Code Files:** GPT-Runner allows you to chat with your code files. you can selected some files or folders, and then chat with them.
 - AI Preset Chat: Developers can utilize `xxx.gpt.md` files for chat creation with Git version control, boosting team collaboration and communication.
 - Custom AI Parameters: Harness the full potential of `xxx.gpt.md` files with customizable options like system/user prompts, model names, and temperature.
 - LLM Compatibility: Built on LangchainJs, GPT-Runner supports OpenAI API key and access token methods, easily adapting to third-party LLMs.
@@ -45,7 +45,7 @@ Read the [documentation](https://gpt-runner.nicepkg.cn/) for more details.
 ## Roadmap
 
 - [ ] Jetbrains Plugin: Add Jetbrains IDE Plugin
-- [ ] Export Chat History: Add dialogue import and export function, compatible with OpenAI specification
+- [ ] Export And Import Chat History: Add dialogue import and export function
 - [ ] AI Preset Store: Add AI Preset Store for community sharing AI Preset File
 - [ ] Template Interpolation: Add template interpolation support
 - [ ] Electron: Add an Electron client to expand the target audience to non-developers
@@ -57,8 +57,8 @@ Read the [documentation](https://gpt-runner.nicepkg.cn/) for more details.
 ## 主要功能
 
 - CLI与IDE集成：GPT-Runner 提供强大的命令行界面和IDE扩展，通过 `xxx.gpt.md` 文件实现AI机器人预设，支持各种IDE的高效AI工作流。
-- 与文件聊天：GPT-Runner 允许您与代码文件聊天。您可以选择一些文件或文件夹，然后与它们聊天。
-- 基于AI预设的聊天：开发人员可以利用xxx.gpt.md文件创建聊天并支持Git版本控制，提升团队协作和沟通。
+- 与代码文件聊天：GPT-Runner 允许您与代码文件聊天。您可以选择一些文件或文件夹，然后与它们聊天。
+- 基于AI预设的聊天：开发人员可以利用 `xxx.gpt.md` 文件创建聊天并支持Git版本控制，提升团队协作和沟通。
 - 自定义AI参数：充分发挥 `xxx.gpt.md` 文件的潜力，可自定义系统/用户提示、模型名称、温度等选项。
 - LLM兼容性：基于 `LangchainJs` 构建，GPT-Runner 支持 OpenAI API Key 和 Access Token 方式，易于适应第三方LLM。
 - 隐私优先：所有数据安全存储在本地PC上。
@@ -73,8 +73,8 @@ Read the [documentation](https://gpt-runner.nicepkg.cn/) for more details.
 ## 开发计划
 
 - [ ] Jetbrains 插件：添加 Jetbrains IDE 插件
-- [ ] 导出聊天记录：添加对话导入导出功能，兼容OpenAI规范
-- [ ] AI预设商店：添加AI预设商店以供社区共享AI预设文件
+- [ ] 导出和导入聊天记录：添加对话导入导出功能
+- [ ] AI预设商店：添加 AI 预设商店以供社区共享 AI 预设文件
 - [ ] 模板插值：添加模板插值支持
 - [ ] Electron：添加 Electron 客户端，将目标受众推广到非开发人员
 
@@ -84,30 +84,14 @@ Read the [documentation](https://gpt-runner.nicepkg.cn/) for more details.
 
 ## FAQ
 
-[English > FAQ](./docs/faq-en.md)
+[English > FAQ](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq-en.md)
 
-[简体中文 > 常见问题](./docs/faq-cn.md)
+[简体中文 > 常见问题](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq-cn.md)
 
 ## Requirements
 
 NodeJS >= 16.15.0
 
-### Local Development
-
-```shell
-# install nodejs >= 16.15.0
-npm i -g pnpm
-pnpm i
-
-# run server
-cd packages/gpt-runner-web && pnpm dev:server
-
-# open a new terminal and run client
-cd packages/gpt-runner-web && pnpm dev:client
-```
-
-Now you can visit `http://localhost:3006` to see the result.
-
 ## Acknowledgement
 
 GPT-Runner is made possible thanks to the inspirations from the following projects:
@@ -127,8 +111,12 @@ no...
 
 ### Contributor
 
-[Contributors](https://github.com/nicepkg/gpt-runner/graphs/contributors)
+**This project exists thanks to all the people who contribute:**
+
+<a href="https://github.com/nicepkg/gpt-runner/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=nicepkg/gpt-runner" />
+</a>
 
 ## LICENSE
 
-[MIT](./LICENSE) License &copy; 2023-PRESENT [Jinming Yang](https://github.com/2214962083)
+[MIT](https://github.com/nicepkg/gpt-runner/tree/main/LICENSE) License &copy; 2023-PRESENT [Jinming Yang](https://github.com/2214962083)

docs/faq-cn.md

@@ -0,0 +1 @@
+faq cn

docs/faq-en.md

@@ -0,0 +1 @@
+faq en

netlify.toml

@@ -3,7 +3,7 @@
   NODE_OPTIONS = "--max_old_space_size=4096"
 
 [build]
-  publish = "docs/dist"
+  publish = "website/dist"
   command = "pnpm run deploy"
 
 [functions]

packages/gpt-runner-cli/README.md

@@ -75,7 +75,7 @@ You can customize the behavior of the `gptr` command using the following options
 
 ## Troubleshooting
 
-If you encounter any issues or need more information on GPT-Runner CLI, refer to the [FAQ](https://github.com/nicepkg/gpt-runner/blob/main/docs/faq-en.md) sections in the project documentation. If you can't find a solution there, feel free to open an [issue](https://github.com/nicepkg/gpt-runner/issues) on the project's GitHub page.
+If you encounter any issues or need more information on GPT-Runner CLI, refer to the [FAQ](https://github.com/nicepkg/gpt-runner/blob/main/website/faq-en.md) sections in the project documentation. If you can't find a solution there, feel free to open an [issue](https://github.com/nicepkg/gpt-runner/issues) on the project's GitHub page.
 
 ## Contributing
 

packages/gpt-runner/README.md

@@ -50,7 +50,7 @@ GPT-Runner exposes various other functions and utilities from the shared `@nicep
 
 ## Troubleshooting
 
-If you encounter any issues or need more information on the GPT-Runner package, refer to the [FAQ](https://github.com/nicepkg/gpt-runner/blob/main/docs/faq-en.md) sections in the project documentation. If you can't find a solution there, feel free to open an [issue](https://github.com/nicepkg/gpt-runner/issues) on the project's GitHub page.
+If you encounter any issues or need more information on the GPT-Runner package, refer to the [FAQ](https://github.com/nicepkg/gpt-runner/blob/main/website/faq-en.md) sections in the project documentation. If you can't find a solution there, feel free to open an [issue](https://github.com/nicepkg/gpt-runner/issues) on the project's GitHub page.
 
 ## Contributing
 

pnpm-workspace.yaml

@@ -1,5 +1,5 @@
 packages:
-  - docs
+  - website
   - playground
   - 'packages/*'
   - 'test/fixtures/*'

tsconfig.json

@@ -36,7 +36,7 @@
   },
   "exclude": [
     "**/dist/**",
-    "./docs/**",
+    "./website/**",
     "**/node_modules/**",
     "**/playground/**",
     "**/examples/**",