diff --git a/docs/zh/contribute/_toc.yaml b/docs/zh/contribute/_toc.yaml index d427d3416b3b98f4be1190fc9837d9e528212566..fa0a48bfed3ce5e62ff4351e8792ebc599cfafd0 100644 --- a/docs/zh/contribute/_toc.yaml +++ b/docs/zh/contribute/_toc.yaml @@ -19,3 +19,5 @@ sections: href: ./doc_tools_static_check.md - label: 高级功能 href: ./doc_tools_functions.md + - label: DocMate 智能写作助手 + href: ./doc_mate.md \ No newline at end of file diff --git a/docs/zh/contribute/ai_service_config.md b/docs/zh/contribute/ai_service_config.md new file mode 100644 index 0000000000000000000000000000000000000000..5aeffc99381ffe27e5214e49615869f53a43d5b1 --- /dev/null +++ b/docs/zh/contribute/ai_service_config.md @@ -0,0 +1,21 @@ +# AI 服务配置指导 + +## 操作指导 + +1. 登录`https://cloud.siliconflow.cn`。 +2. 获取 API 密钥,如下图所示。 + + ![get api key](figures/get_apikey.png) +3. 进入模型广场,选择合适的模型,点击进入详情页。 + + ![models](figures/models.png) +4. 复制模型名字。 + + ![copy model name](figures/copy_model_name.png) +5. 进入 DocMate 的 AI 服务配置页,填写以下配置项: + + - 基础URL:`https://api.siliconflow.cn/v1`。 + - API密钥:步骤2中获取的API密钥。 + - 模型名称:步骤3中获取的模型名称,为保障稳定运行,建议填写`Qwen/Qwen3-235B-A22B-Instruct-2507`。 + + ![api service config](figures/api_service_config.png) diff --git a/docs/zh/contribute/doc_mate.md b/docs/zh/contribute/doc_mate.md new file mode 100644 index 0000000000000000000000000000000000000000..b5baa89f250b0716fa33ebcfed55455ec2a8f521 --- /dev/null +++ b/docs/zh/contribute/doc_mate.md @@ -0,0 +1,61 @@ +# DocMate 智能写作助手 + +## 功能介绍 + +DocMate 是专为开源社区文档打造的 VS Code 智能写作助手。它为文档创作提供全流程的 AI 支持,有效提升文档的规范性与写作效率,让每一位开发者都能轻松写出专业级技术文档。 + +- 文档检查 + - 中文错别字检查; + - 标点符号规范; + - 空格规范; + - 格式规范; + - 风格一致性; + - 超链接检查; + - 术语规范。 +- 文本润色 + - 表达优化:提升文档的清晰度和专业性; + - 结构调整:优化段落结构与语句逻辑; + - 语言精炼:简化技术表达,使其更加简明易懂。 +- 智能重写 + - 支持自定义重写指令,满足多样化的内容需求。 + +## 使用方法 + +- 安装插件 + 1. 打开 VS Code,进入扩展商店(Ctrl+Shift+X); + 2. 搜索“DocMate”,点击安装; + + ![docmate check](figures/docmate_install.png) + + 3. 点击左侧活动栏的**DocMate**图标,打开专用侧边栏。 +- 配置AI服务 + 1. 点击侧边栏右上角的**设置**图标; + 2. 用户需自行获取模型服务,可参考[指导](https://gitee.com/openeuler/docs/blob/stable-common/docs/zh/contribute/ai_service_config.md)进行配置; +- 基本使用 + 1. 打开文档:在 VS Code 中打开 Markdown 文件; + 2. 选择文本:选中需要处理的文本内容; + 3. 按需进行检查、润色或改写; + 4. 查看处理结果和建议,可一键应用改进建议。 + + ![docmate use](figures/docmate_use.png) +- 检查项配置 + 1. 点击侧边栏右上角的**检查规则管理**图标; + 2. 查看默认检查规则; + 3. 通过开关控制,灵活启用/禁用检查项; + 4. 点击右上角的**新建规则**按钮,自定义符合特定需求的检查规则。 + + ![docmate config](figures/docmate_config.png) + +## 使用示例 + +- 检查 + + ![docmate check](public_sys_resources/docmate_check.gif) + +- 润色 + + ![docmate improve](public_sys_resources/docmate_improve.gif) + +- 改写 + + ![docmate rewrite](public_sys_resources/docmate_rewrite.gif) diff --git a/docs/zh/contribute/figures/api_service_config.png b/docs/zh/contribute/figures/api_service_config.png new file mode 100644 index 0000000000000000000000000000000000000000..c67cf322564218df0d057454a74ad522e75a771a Binary files /dev/null and b/docs/zh/contribute/figures/api_service_config.png differ diff --git a/docs/zh/contribute/figures/copy_model_name.png b/docs/zh/contribute/figures/copy_model_name.png new file mode 100644 index 0000000000000000000000000000000000000000..75177fc73aa755f2df58a3e17f05f0381a1ee00c Binary files /dev/null and b/docs/zh/contribute/figures/copy_model_name.png differ diff --git a/docs/zh/contribute/figures/docmate_config.png b/docs/zh/contribute/figures/docmate_config.png new file mode 100644 index 0000000000000000000000000000000000000000..64c040501d2f26d2fba2d5ca2712bb360bcf0ec0 Binary files /dev/null and b/docs/zh/contribute/figures/docmate_config.png differ diff --git a/docs/zh/contribute/figures/docmate_install.png b/docs/zh/contribute/figures/docmate_install.png new file mode 100644 index 0000000000000000000000000000000000000000..33a1a842f1c830be5243457851fcc9a9e2b6ba8c Binary files /dev/null and b/docs/zh/contribute/figures/docmate_install.png differ diff --git a/docs/zh/contribute/figures/docmate_use.png b/docs/zh/contribute/figures/docmate_use.png new file mode 100644 index 0000000000000000000000000000000000000000..38ff428e80b6ad5295a0309ed30b823212ae81ad Binary files /dev/null and b/docs/zh/contribute/figures/docmate_use.png differ diff --git a/docs/zh/contribute/figures/get_apikey.png b/docs/zh/contribute/figures/get_apikey.png new file mode 100644 index 0000000000000000000000000000000000000000..3d60670ccdcf4417c64cbcc101eff0fc8713da51 Binary files /dev/null and b/docs/zh/contribute/figures/get_apikey.png differ diff --git a/docs/zh/contribute/figures/models.png b/docs/zh/contribute/figures/models.png new file mode 100644 index 0000000000000000000000000000000000000000..05842b7f772c9b1286896868c9bf29b23baf1caa Binary files /dev/null and b/docs/zh/contribute/figures/models.png differ diff --git "a/docs/zh/contribute/openEuler\345\274\200\346\272\220\347\244\276\345\214\272\350\264\241\347\214\256\346\214\207\345\215\227.md" "b/docs/zh/contribute/openEuler\345\274\200\346\272\220\347\244\276\345\214\272\350\264\241\347\214\256\346\214\207\345\215\227.md" index 9fbd6c1708d44492aaca75348030032e4f4e0852..cea12e3516f114c3f18c4aefbc2d4d1dcadd1a35 100644 --- "a/docs/zh/contribute/openEuler\345\274\200\346\272\220\347\244\276\345\214\272\350\264\241\347\214\256\346\214\207\345\215\227.md" +++ "b/docs/zh/contribute/openEuler\345\274\200\346\272\220\347\244\276\345\214\272\350\264\241\347\214\256\346\214\207\345\215\227.md" @@ -2,7 +2,7 @@ # 前言 -openEuler 是一款由全球开源贡献者构建的高效、稳定、安全的开源操作系统。同时, openEuler 是一个面向全球的操作系统开源社区,通过社区合作,打造创新平台。本文以贡献Gitee平台上的openEuler 社区为例,为开源社区贡献者提供详细的贡献指导,从基础介绍到网页操作到工具使用再到贡献流程,全方位推动开源社区繁荣。 +openEuler 是一个由全球贡献者共建的高效、稳定、安全的开源操作系统和社区,致力于打造持续创新的技术平台。本文以向 Gitee 上的 openEuler 社区贡献代码为例,系统指导贡献者完成从入门到实践的全流程,助力社区发展。 # 开源基础 diff --git a/docs/zh/contribute/public_sys_resources/docmate_check.gif b/docs/zh/contribute/public_sys_resources/docmate_check.gif new file mode 100644 index 0000000000000000000000000000000000000000..8643d956d84528e9d7fd25af79facf940368cb14 Binary files /dev/null and b/docs/zh/contribute/public_sys_resources/docmate_check.gif differ diff --git a/docs/zh/contribute/public_sys_resources/docmate_improve.gif b/docs/zh/contribute/public_sys_resources/docmate_improve.gif new file mode 100644 index 0000000000000000000000000000000000000000..863b8de1d9f8bd08eeaedaf156ff83ff1875d98b Binary files /dev/null and b/docs/zh/contribute/public_sys_resources/docmate_improve.gif differ diff --git a/docs/zh/contribute/public_sys_resources/docmate_rewrite.gif b/docs/zh/contribute/public_sys_resources/docmate_rewrite.gif new file mode 100644 index 0000000000000000000000000000000000000000..7dbbf6056de1299fb073db5b73076b8122e38ffc Binary files /dev/null and b/docs/zh/contribute/public_sys_resources/docmate_rewrite.gif differ