From 8e08357d1237a0ff3034fc0fad84df57ef28a3d4 Mon Sep 17 00:00:00 2001 From: geeklog Date: Thu, 30 Nov 2023 17:31:08 +0800 Subject: [PATCH] Fix typos for README --- README.md | 2 +- README_ZH.md | 48 +++++++++++++++++++++++++++++------------------- 2 files changed, 30 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index bbd96114..2b7e7cb9 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ Select a block of code, then right-click on the "DevPilot" option on the context - Performance Check - Explain This -![img.png](doc/images/screenshot/en/chat_menu.png) +![menu](doc/images/screenshot/en/chat_menu.png) **For example**, select the code, right-click ❯ DevPilot ❯ Fix This. diff --git a/README_ZH.md b/README_ZH.md index 66a8c082..0239fb48 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -30,77 +30,85 @@ idea官方市场 - 目前内测阶段暂时未上架，后续release正式版本后会上架到市场 压缩包安装 - 在plugin页面选择设置中的从磁盘安装，之后将zip包导入即可，压缩包下载地址：下载 -![img.png](doc/images/screenshot/cn/install_from_disk.png) +![install from disk](doc/images/screenshot/cn/install_from_disk.png) ## 配置插件 + 插件安装成功后，在idea设置页面的Tools中就能找到DevPilot的配置页面 -![img_1.png](doc/images/screenshot/en/config.png) +![configuration](doc/images/screenshot/en/config.png) 在配置页面可以切换插件的中英文，以及选择不同模型和模型的地址，用户名则是在对话时在页面展示时使用。 -![img_19.png](doc/images/screenshot/cn/settings.png) +![settings](doc/images/screenshot/cn/settings.png) ## 插件功能 + DevPilot为开发者提供了丰富的能力来协助开发者能够省去繁琐的测试用例和注释编写，也能够帮助开发者编写更加高效的代码，同时也能帮助排查代码的问题等等。 ### 生成式AI对话 + 插件支持对话能力，通过右键或者是右边侧边栏的入口可以打开对话的页面 -![img_20.png](doc/images/screenshot/cn/welcome.png) +![welcome](doc/images/screenshot/cn/welcome.png) -![img_5.png](doc/images/screenshot/cn/menu_chat.png) +![menu chat](doc/images/screenshot/cn/menu_chat.png) 在对话框中可以编写问题，通过回车或者是发送按钮进行聊天问题的发送，后续OpenAI会返回回答并在当前页面输出 -![img_6.png](doc/images/screenshot/cn/chat.png) +![chat](doc/images/screenshot/cn/chat.png) ### 生成测试用例 + 用户可以通过我们插件来生成测试用例。用户选中某个方法右键点击Generate Tests -![img_7.png](doc/images/screenshot/cn/menu_testcase.png) +![menu testcase](doc/images/screenshot/cn/menu_testcase.png) 之后窗口会自动打开然后窗口会返回相关的测试用例，用户可以直接复制测试，或者直接选择在光标处插入或者替换相关的代码，甚至还可以新建测试类文件 -![img_8.png](doc/images/screenshot/cn/testcase_result.png) +![testcase result](doc/images/screenshot/cn/testcase_result.png) ### 生成注释 + 插件支持代码注释的生成功能。用户选中代码块后右键点击Generate comments -![img_9.png](doc/images/screenshot/cn/menu_gen_comments.png) +![menu gen comments](doc/images/screenshot/cn/menu_gen_comments.png) 之后窗口自动打开会返回相关的注释结果，并且在编辑器中会自动将生成注释后的结果和原先的代码进行diff，用户可以自行进行比对接受对应的注释。 ### 修复代码 + 插件支持修复代码的能力。用户选中代码块后右键点击Fix This -![img_10.png](doc/images/screenshot/cn/menu_fix_bug.png) +![menu fix bug](doc/images/screenshot/cn/menu_fix_bug.png) 之后窗口自动打开会返回相关的修复建议，用户可以根据建议修改代码 -![img_11.png](doc/images/screenshot/cn/fix_bug_result.png) +![fix bug result](doc/images/screenshot/cn/fix_bug_result.png) + +### Review 代码 -### review代码 插件支持review代码的能力。用户选中代码块后右键点击Review Code -![img_12.png](doc/images/screenshot/cn/menu_code_review.png) +![menu code review](doc/images/screenshot/cn/menu_code_review.png) 之后窗口自动打开会返回相关的review结果，用户可以根据结果来编辑自己的代码逻辑 -![img_13.png](doc/images/screenshot/cn/code_review_result.png) +![code review result](doc/images/screenshot/cn/code_review_result.png) ### 性能检测 + 插件支持对代码进行性能检测。用户选中代码块后右键点击Performance Check -![img_14.png](doc/images/screenshot/cn/menu_performance_check.png) +![menu performance check](doc/images/screenshot/cn/menu_performance_check.png) 之后窗口自动打开会返回相关的性能检测结果，并且在编辑器中会自动将代码优化后的结果和原先的代码进行diff，用户可以根据结果来优化代码 -![img_15.png](doc/images/screenshot/cn/performance_check_result.png) +![performance check result](doc/images/screenshot/cn/performance_check_result.png) ### 清理缓存 -插件整体的相关能力都是附带上下文的，但是上下文可能会存在污染这种情况，并且OpenAI或者是其他的大模型都可能会存在token的限制，超出限制会进行报错。因此我们提供清理的能力，在窗口右上角点击清除按钮就可以将当前会话全部清空。 -![img_16.png](doc/images/screenshot/cn/clear_context.png) +插件整体的相关能力都是附带上下文的，但是上下文可能会存在污染这种情况，并且OpenAI或者是其他的大模型都可能会存在token的限制，超出限制会进行报错。因此我们提供清理的能力，在窗口右上角点击清除按钮就可以将当前会话全部清空。 +![clear context](doc/images/screenshot/cn/clear_context.png) ## 路线图 @@ -111,6 +119,7 @@ DevPilot为开发者提供了丰富的能力来协助开发者能够省去繁琐 我们很快将支持将Codellama(这是Meta开发的一个开源LLM)集成到DevPilot中。这将使您能够在本地开发环境中利用LLM的力量,而无需将任何敏感数据发送给OpenAI。 通过Codellama集成,用户可以期待: + - 更准确、与上下文相关的代码建议,Codellama具有10万个上下文长度,因此它提供的建议将基于对代码上下文的更深入理解。这将显著减少开发人员在弄清楚适当代码要使用的时间。 - 通过在大规模代码库上进行微调,在某些情况下,Codellama可以胜过ChatGPT。 @@ -121,6 +130,7 @@ Codellama的使用,请参阅[将Codellama部署到您的本地环境](https://gi 展望未来,我们计划通过支持模型即服务(MaaS)进一步扩展我们的功能。MaaS提供了以服务为基础的方式利用AI模型的功能,而无需本地部署或维护。此功能将使最新的AI模型可无缝访问,而无需承担计算成本或在本地管理这些模型的复杂性。 通过将MaaS集成到DevPilot中,我们旨在: + - 无需设置OpenAI API密钥即可访问最新的OpenAI模型。 - 提供即插即用的解决方案来访问最先进的AI模型。 - 让开发人员在无需本地资源的情况下利用最新的AI进步。 @@ -132,4 +142,4 @@ Codellama的使用,请参阅[将Codellama部署到您的本地环境](https://gi ## 联系我们 -如果有任何问题或建议,请通过电子邮件联系我们 [pilot_group@zhongan.com](mailto:pilot_group@zhongan.com)。 \ No newline at end of file +如果有任何问题或建议,请通过电子邮件联系我们 [pilot_group@zhongan.com](mailto:pilot_group@zhongan.com)。