Skip to content

Commit

Permalink
docs: update doc and slogan
Browse files Browse the repository at this point in the history
  • Loading branch information
2214962083 committed Jul 31, 2024
1 parent b351230 commit 7e13674
Show file tree
Hide file tree
Showing 20 changed files with 235 additions and 73 deletions.
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<div align="center">

<h1 align="center">Aide</h1>
<h1 align="center">AIDE</h1>

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)
Expand All @@ -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 📦

Expand Down
20 changes: 9 additions & 11 deletions README_CN.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<div align="center">

<h1 align="center">Aide</h1>
<h1 align="center">AIDE</h1>

[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)
Expand All @@ -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 提示。

## 安装 📦

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": "[email protected]",
Expand Down
8 changes: 8 additions & 0 deletions website/.vitepress/config/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -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'
Expand Down
8 changes: 8 additions & 0 deletions website/.vitepress/config/zh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,10 @@ function sidebar(): DefaultTheme.Sidebar {
text: '智能粘贴',
link: '/smart-paste'
},
{
text: 'AI 批量处理',
link: '/batch-processor'
},
{
text: '批量复制文件为 AI 提示词',
link: '/copy-as-prompt'
Expand Down Expand Up @@ -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'
Expand Down
15 changes: 15 additions & 0 deletions website/en/guide/configuration/api-concurrency.md
Original file line number Diff line number Diff line change
@@ -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`.
:::
2 changes: 1 addition & 1 deletion website/en/guide/features/ask-ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
54 changes: 54 additions & 0 deletions website/en/guide/features/batch-processor.md
Original file line number Diff line number Diff line change
@@ -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.

:::

<Video src="/videos/aide-batch-processor.mp4"/>

::: tip

1. For long file codes, there may be issues with output interruption. Currently, there is no good solution.
2. Carefully review the processed files to ensure they are correct before replacing the source files. Never assume that AI-processed code is error-free.

:::

**Related Configuration:**

- You can customize the AI request concurrency by modifying the [`aide.apiConcurrency`](../configuration/api-concurrency.md) configuration.
2 changes: 1 addition & 1 deletion website/en/guide/features/copy-as-prompt.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Copies the content of the selected files to the clipboard and formats it as AI i

**Usage:**

- Select files or folders in the explorer.
- Select files or folders in the explorer. (Multi-select: hold `Ctrl` or `Cmd` and click on files or folders)
- Right-click and select `✨ Aide: Copy as AI Prompt`.

<Video src="/videos/aide-copy-as-prompt.mp4"/>
Expand Down
40 changes: 23 additions & 17 deletions website/en/guide/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,41 +5,47 @@

## Why Choose `Aide`?

- **😩 Are you suffering from reading through the messy code left by your predecessors?**
`Aide` is a powerful AI-assisted development `VSCode` extensions designed to enhance your coding experience. Here's why you should choose `Aide`:

`Aide` can add detailed comments to your code with one click, outputting to a temporary file for you to review, thereby improving code readability.
- **📚 Improved Code Readability**: Add detailed comments to your code with one click, improving readability without modifying the original file.

- **🆕 Are you learning a new language or reading a project in an unfamiliar language and wish to understand the new code in a familiar language?**
- **🔄 Effortless Code Conversion**: Convert code between languages or frameworks instantly, making it easier to understand unfamiliar code or migrate projects.

`Aide` can convert code into a familiar language with one click, outputting to a temporary file so you can immediately understand its logic.
- **🔮 Magical Smart Paste**: Intelligently convert clipboard content when pasting, including transforming design screenshots into UI code. Streamlines cross-language, cross-framework development, and design-to-code workflows.

- **📋 Do you have to manually copy multiple file codes and paste them into an AI website for questions every time?**
- **📋 Efficient Batch Processing**: Easily process multiple files or folders with AI, significantly boosting your productivity.

`Aide` allows you to batch copy multiple files or folders with one click, saving you a lot of time.
- **🏷️ Intelligent Variable Renaming**: Get AI-powered variable name suggestions with explanations, helping you choose the best names for your code.

- **🤔 Are you always dissatisfied with your variable names?**
- **🤖 Customizable AI Commands**: Create and execute custom AI commands, allowing for flexible interaction with your codebase.

`Aide` can use AI to provide variable name suggestions and explanations, allowing you to choose the best practice variable names and make your code more standardized.
## Key Features

- **🔄 Do you often need to convert code from one format to another before pasting it into your project?**
1. **[Code Viewer Helper](../features/code-viewer-helper.md)**: Add AI-generated comments to make your code easier to understand.

`Aide` can intelligently recognize code in the clipboard and guess your intent for smart pasting. For example, if you copy a `JSON` and paste it into a `TypeScript` file, it will automatically convert it to a `TypeScript` type. Or if you copy `Tailwind CSS` code and paste it into a `Flutter Dart` file, it will automatically convert it to a `Flutter Widget`, saving you a lot of time.
2. **[Code Convert](../features/code-convert.md)**: Transform code from one programming language to another with AI assistance.

- **⌨️ When using command line tools similar to [`aider`](https://github.com/paul-gauthier/aider), do you dislike entering file paths one by one?**
3. **[Smart Paste](../features/smart-paste.md)**: Intelligently convert clipboard content when pasting into different file types.

`Aide` allows you to customize AI command execution templates, passing selected file paths to the AI command, significantly saving your time.
4. **[AI Batch Processor](../features/batch-processor.md)**: Process multiple files with AI according to your specific requirements

5. **[Copy Multiple Files As AI Prompt](../features/copy-as-prompt.md)**: Format multiple files as AI interaction prompts with a single click.

6. **[Rename Variable](../features/rename-variable.md)**: Get AI suggestions for variable names to improve code clarity.

7. **[Ask AI With Custom Command](../features/ask-ai.md)**: Execute customized AI commands on selected files or folders.

## Differences Between `Aide` and `Copilot/Codeium/AmazonQ`

- **🚫 No Redundant Features**: We won't create a sidebar for AI chat, nor will we provide AI auto-completion features, because these are already offered by other tools. We only provide features that we can do better. `Aide` is a supplement, not a replacement.
- **🚫 No Redundant Features**: We focus on unique, complementary features rather than replicating existing tools.

- **Focus on Efficiency and Practicality**: `Aide` focuses on providing more efficient AI features and more practical interaction methods. Each feature is deeply thought out and designed by the author to ensure a good user experience.
- **⚡ Efficiency-Focused**: Each feature is carefully designed for optimal user experience and practical utility.

- **❌ No Poor-Performing Features**: `Aide` will not offer features with poor performance, such as embedding an entire project into an AI and asking it questions. Such features usually perform poorly, so we won't offer them.
- **💪 Quality Over Quantity**: We prioritize high-performing features, avoiding those with poor real-world results.

- **🔓 Open Source**: `Aide` is open source, allowing you to freely view the source code.
- **🔓 Open Source**: Freely view and contribute to our source code.

- **🛠️ Customizable**: `Aide` allows you to customize the AI model and even use local models.
- **🛠️ Customizable**: Use your preferred AI model, including local options.

## Quick Navigation

Expand Down
4 changes: 2 additions & 2 deletions website/en/guide/use-another-llm/ollama.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can configure [`aide.openaiKey`](../configuration/openai-key.md) with any va

### Model Configuration

You need to configure [`aide.openaiModel`](../configuration/openai-model.md) to the `Ollama` model. We recommend using the `gemma2` model. For more models, please refer to the [Supported Models List](https://ollama.com/library).
You need to configure [`aide.openaiModel`](../configuration/openai-model.md) to the `Ollama` model. We recommend using the `llama3.1` model. For more models, please refer to the [Supported Models List](https://ollama.com/library).

### Example Configuration File

Expand All @@ -30,7 +30,7 @@ Below is a complete configuration example:
{
"aide.openaiBaseUrl": "http://localhost:11434/v1",
"aide.openaiKey": "sk-ollama",
"aide.openaiModel": "gemma2"
"aide.openaiModel": "llama3.1"
}
```

Expand Down
6 changes: 3 additions & 3 deletions website/en/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
layout: home

title: Aide
titleTemplate: Mastering Any Code In VSCode
titleTemplate: Conquer Any Code in VSCode

hero:
name: Aide
image: /logo.svg
text: 'Mastering Any Code In VSCode 💪'
tagline: 'One-click commenting and language conversion.'
text: 'Conquer Any Code in VSCode 💪'
tagline: 'One-Click Comments, Conversions, UI-to-Code, and AI Batch Processing!'
actions:
- theme: brand
text: Get Started
Expand Down
15 changes: 15 additions & 0 deletions website/zh/guide/configuration/api-concurrency.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# aide.apiConcurrency

此配置允许您自定义 AI 请求并发数,默认是 `1`,用本地模型的最好不要改。

- **默认值:**

```json
{
"aide.apiConcurrency": 1
}
```

::: tip 提示
你可以通过改大这个数目来提升 [`AI 批量处理`](../features/batch-processor.md) 的速度。不建议超过 `3`
:::
2 changes: 1 addition & 1 deletion website/zh/guide/configuration/read-clipboard-image.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@

目前支持以下场景:

- [`智能粘贴`](../features//smart-paste.md)
- [`智能粘贴`](../features/smart-paste.md)
2 changes: 1 addition & 1 deletion website/zh/guide/features/ask-ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

**使用方法:**

- 在资源管理器中选择文件或文件夹。
- 在资源管理器中选择文件或文件夹。(多选方法:按住 `Ctrl``Cmd` 并点击文件或文件夹)
- 右键选择 `✨ Aide: 问 AI`
- 按提示输入您的问题。

Expand Down
Loading

0 comments on commit 7e13674

Please sign in to comment.