From 7e136744f6d862b9122840e7721b7467bf74bd60 Mon Sep 17 00:00:00 2001 From: JinmingYang <2214962083@qq.com> Date: Wed, 31 Jul 2024 23:38:59 +0800 Subject: [PATCH] docs: update doc and slogan --- README.md | 22 ++++---- README_CN.md | 20 ++++--- package.json | 2 +- website/.vitepress/config/en.ts | 8 +++ website/.vitepress/config/zh.ts | 8 +++ .../en/guide/configuration/api-concurrency.md | 15 ++++++ website/en/guide/features/ask-ai.md | 2 +- website/en/guide/features/batch-processor.md | 54 +++++++++++++++++++ website/en/guide/features/copy-as-prompt.md | 2 +- website/en/guide/getting-started/index.md | 40 ++++++++------ website/en/guide/use-another-llm/ollama.md | 4 +- website/en/index.md | 6 +-- .../zh/guide/configuration/api-concurrency.md | 15 ++++++ .../configuration/read-clipboard-image.md | 2 +- website/zh/guide/features/ask-ai.md | 2 +- website/zh/guide/features/batch-processor.md | 54 +++++++++++++++++++ website/zh/guide/features/copy-as-prompt.md | 2 +- website/zh/guide/getting-started/index.md | 40 ++++++++------ website/zh/guide/use-another-llm/ollama.md | 4 +- website/zh/index.md | 6 +-- 20 files changed, 235 insertions(+), 73 deletions(-) create mode 100644 website/en/guide/configuration/api-concurrency.md create mode 100644 website/en/guide/features/batch-processor.md create mode 100644 website/zh/guide/configuration/api-concurrency.md create mode 100644 website/zh/guide/features/batch-processor.md diff --git a/README.md b/README.md index 7591f6e..d84441a 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@
-

Aide

+

AIDE

English / [简体中文 🌏](https://github.com/nicepkg/aide/tree/master/README_CN.md) -Mastering Any Code In VSCode: One-click commenting and language conversion. 💪 +Conquer Any Code in VSCode: One-Click Comments, Conversions, UI-to-Code, and AI Batch Processing! 💪 -在 VSCode 里掌握任何屎山代码:一键注释和语言转换。💪 +在 VSCode 中征服任何代码:一键注释、转换、UI 图生成代码、AI 批量处理!💪 [![Version](https://img.shields.io/visual-studio-marketplace/v/nicepkg.aide-pro)](https://marketplace.visualstudio.com/items?itemName=nicepkg.aide-pro) [![Downloads](https://img.shields.io/visual-studio-marketplace/d/nicepkg.aide-pro)](https://marketplace.visualstudio.com/items?itemName=nicepkg.aide-pro) @@ -25,15 +25,13 @@ https://github.com/user-attachments/assets/55f85f8e-7515-4da3-b850-9c078b3440d5 ## Features ✨ -- 🔄 **Code Conversion**: One-click code transformation between languages. -- 📖 **Code Annotation**: One-click detailed comments for better readability. -- 📋 **Quick Copy**: Batch copy files/folders as AI prompts. -- 💬 **Custom Commands**: Execute custom AI commands on selected files. -- 🔀 **Variable Rename**: Rename variables using AI-suggested variable names. -- 🎛 **Prompt Templates**: Define flexible AI prompt templates. -- 📁 **Multi-File Support**: Select multiple files/folders for AI prompts or commands. -- 🚫 **Ignore Patterns**: Exclude files/folders using custom glob rules. -- ⌨ **Keyboard Shortcuts**: Set your preferred shortcuts for features. +- 🔄 **[Code Convert](https://aide.nicepkg.cn/guide/features/code-convert)**: Transform code between any programming languages with one click. +- 📖 **[Code Viewer Helper](https://aide.nicepkg.cn/guide/features/code-viewer-helper)**: Add detailed comments to enhance code readability. +- 🔀 **[Smart Paste](https://aide.nicepkg.cn/guide/features/smart-paste)**: Intelligently convert clipboard content (code or images) when pasting. +- 🤖 **[AI Batch Processor](https://aide.nicepkg.cn/guide/features/batch-processor)**: Process multiple files using AI according to custom requirements. +- 🏷 **[Rename Variable](https://aide.nicepkg.cn/guide/features/rename-variable)**: Get AI-suggested variable names with explanations. +- 💬 **[Ask AI](https://aide.nicepkg.cn/guide/features/ask-ai)**: Execute custom AI commands on selected files or folders. +- 📋 **[Copy as AI Prompt](https://aide.nicepkg.cn/guide/features/copy-as-prompt)**: Easily copy files/folders content as AI prompts. ## Installation 📦 diff --git a/README_CN.md b/README_CN.md index f02666b..8878323 100644 --- a/README_CN.md +++ b/README_CN.md @@ -1,10 +1,10 @@
-

Aide

+

AIDE

[English 🌏](https://github.com/nicepkg/aide/tree/master/README.md) / 简体中文 -在 VSCode 里掌握任何屎山代码:一键注释和语言转换。💪 +在 VSCode 中征服任何代码:一键注释、转换、UI 图生成代码、AI 批量处理!💪 [![Version](https://img.shields.io/visual-studio-marketplace/v/nicepkg.aide-pro)](https://marketplace.visualstudio.com/items?itemName=nicepkg.aide-pro) [![Downloads](https://img.shields.io/visual-studio-marketplace/d/nicepkg.aide-pro)](https://marketplace.visualstudio.com/items?itemName=nicepkg.aide-pro) @@ -23,15 +23,13 @@ https://github.com/user-attachments/assets/55f85f8e-7515-4da3-b850-9c078b3440d5 ## 功能 ✨ -- 🔄 **代码转换**:一键代码语言转换。 -- 📖 **代码注释**:一键添加详细注释,提升可读性。 -- 📋 **快速复制**:批量复制文件/文件夹为 AI 提示。 -- 💬 **自定义命令**:对选定文件执行自定义 AI 命令。 -- 🔀 **变量重命名**:使用 AI 给出的变量名建议重命名变量。 -- 🎛 **提示模板**:定义灵活的 AI 提示模板。 -- 📁 **多文件支持**:选择多个文件/文件夹进行 AI 提示或命令。 -- 🚫 **忽略模式**:使用自定义 glob 规则排除文件/文件夹。 -- ⌨ **快捷键**:设置你偏好的功能快捷键。 +- 🔄 **[代码转换](https://aide.nicepkg.cn/zh/guide/features/code-convert)**: 一键在任何编程语言之间转换代码。 +- 📖 **[代码查看器助手](https://aide.nicepkg.cn/zh/guide/features/code-viewer-helper)**: 添加详细注释以提高代码可读性。 +- 🔀 **[智能粘贴](https://aide.nicepkg.cn/zh/guide/features/smart-paste)**: 粘贴时智能转换剪贴板内容(代码或图片)。 +- 🤖 **[AI 批量处理](https://aide.nicepkg.cn/zh/guide/features/batch-processor)**: 根据自定义要求使用 AI 处理多个文件。 +- 🏷 **[重命名变量](https://aide.nicepkg.cn/zh/guide/features/rename-variable)**: 获取 AI 建议的变量名及解释。 +- 💬 **[问 AI](https://aide.nicepkg.cn/zh/guide/features/ask-ai)**: 对选定的文件或文件夹执行自定义 AI 命令。 +- 📋 **[复制为 AI 提示词](https://aide.nicepkg.cn/zh/guide/features/copy-as-prompt)**: 轻松复制文件/文件夹内容作为 AI 提示。 ## 安装 📦 diff --git a/package.json b/package.json index a2f044b..157602e 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "publisher": "nicepkg", "name": "aide-pro", "displayName": "Aide", - "description": "Master Any Code: One-Click Comments and Language Conversion. 掌握任何屎山代码:一键注释和语言转换。💪", + "description": "Conquer Any Code in VSCode: One-Click Comments, Conversions, UI-to-Code, and AI Batch Processing! 在 VSCode 中征服任何代码:一键注释、转换、UI 图生成代码、AI 批量处理!💪", "version": "1.16.0", "private": true, "packageManager": "pnpm@9.3.0", diff --git a/website/.vitepress/config/en.ts b/website/.vitepress/config/en.ts index 5c10146..81955b7 100644 --- a/website/.vitepress/config/en.ts +++ b/website/.vitepress/config/en.ts @@ -88,6 +88,10 @@ function sidebar(): DefaultTheme.Sidebar { text: 'Smart Paste', link: '/smart-paste' }, + { + text: 'AI Batch Processor', + link: '/batch-processor' + }, { text: 'Copy Multiple Files As Prompt', link: '/copy-as-prompt' @@ -113,6 +117,10 @@ function sidebar(): DefaultTheme.Sidebar { text: 'aide.openaiBaseUrl', link: '/openai-base-url' }, + { + text: 'aide.apiConcurrency', + link: '/api-concurrency' + }, { text: 'aide.useSystemProxy', link: '/use-system-proxy' diff --git a/website/.vitepress/config/zh.ts b/website/.vitepress/config/zh.ts index 08762e9..066b818 100644 --- a/website/.vitepress/config/zh.ts +++ b/website/.vitepress/config/zh.ts @@ -112,6 +112,10 @@ function sidebar(): DefaultTheme.Sidebar { text: '智能粘贴', link: '/smart-paste' }, + { + text: 'AI 批量处理', + link: '/batch-processor' + }, { text: '批量复制文件为 AI 提示词', link: '/copy-as-prompt' @@ -143,6 +147,10 @@ function sidebar(): DefaultTheme.Sidebar { text: 'aide.openaiBaseUrl', link: '/openai-base-url' }, + { + text: 'aide.apiConcurrency', + link: '/api-concurrency' + }, { text: 'aide.useSystemProxy', link: '/use-system-proxy' diff --git a/website/en/guide/configuration/api-concurrency.md b/website/en/guide/configuration/api-concurrency.md new file mode 100644 index 0000000..6aa82a9 --- /dev/null +++ b/website/en/guide/configuration/api-concurrency.md @@ -0,0 +1,15 @@ +# aide.apiConcurrency + +This configuration allows you to customize the AI request concurrency, which is `1` by default. It is recommended not to change it when using local models. + +- **Default Value:** + + ```json + { + "aide.apiConcurrency": 1 + } + ``` + +::: tip +You can increase this number to speed up the [`AI Batch Processing`](../features/batch-processor.md). It is not recommended to exceed `3`. +::: diff --git a/website/en/guide/features/ask-ai.md b/website/en/guide/features/ask-ai.md index 5bc3186..a26eda8 100644 --- a/website/en/guide/features/ask-ai.md +++ b/website/en/guide/features/ask-ai.md @@ -6,7 +6,7 @@ Prepare and execute a custom AI command based on the selected file and user inpu **Usage:** -- Select a file or folder in the explorer. +- Select a file or folder in the explorer. (Multi-select: hold `Ctrl` or `Cmd` and click on files or folders) - Right-click and select `✨ Aide: Ask AI`. - Follow the prompt to enter your question. diff --git a/website/en/guide/features/batch-processor.md b/website/en/guide/features/batch-processor.md new file mode 100644 index 0000000..bcc2c8f --- /dev/null +++ b/website/en/guide/features/batch-processor.md @@ -0,0 +1,54 @@ +# AI Batch Processor + +Command Name: `aide.batchProcessor` + +Use AI to process the code of multiple selected files according to your needs. + +**What it can do:** + +- Batch add detailed comments +- Batch optimize code +- Batch convert `vue2` code to `vue3` code +- Batch convert `vue` code to `react` code +- Batch convert `react` code to `flutter` code +- Batch convert `react class component` code to `react function component` code +- Batch convert `rust` code to `js` code +- Batch convert `json` code to `yaml` code +- Use your imagination... + +**What it cannot do:** + +- Specific business requirements +- Split one file into multiple files + +**Rest assured! Processing will not modify the `source file`:** + +- It will generate an additional `file copy`. For example, `app/index.py` -> `app/index.py.aide.py`. +- You can click the `file copy`, review it, and then decide whether to replace the `source file`. +- When opening the `file copy`, the `source file` will be opened simultaneously, allowing you to compare at any time. +- You can click the `Replace Original` button on the first line of the `file copy` to replace the `source file`. + +**Usage:** + +- Select files or folders in the file explorer. (Multi-select: hold `Ctrl` or `Cmd` and click on files or folders) +- Right-click and select `✨ Aide: AI Batch Processor`. +- Enter your code processing requirements. + +::: warning + +This feature requires the AI model to support the `function_call` feature. + +::: + +