已关闭
[enhancement] 优化 README 文档结构 #59
guomengwei创建于  3月30日关闭于  3月31日
guomengwei成员
3月30日 创建

负责人 / 里程碑

  • 负责人:已默认指派(如需调整请在右侧修改 Assignee)
  • 里程碑:如需添加,请在右侧选择 Milestone(模板无法自动设置)

里程碑(可选)

背景(必填)

当前 IDE-Plugins 仓库的 README 同时承载了插件仓库说明和插件使用说明,和 Docs 中的《CJMP 插件使用指南》存在较多内容重复,包括插件安装、创建项目、构建、运行与调试等内容。

目标(必填)

明确 IDE-Plugins README 的定位,将其作为仓库级说明文档,而不是插件完整使用手册,并完成以下目标:

  • 减少与 Docs 用户文档的重复内容
  • 保留插件仓库开发者关心的构建、打包、安装信息
  • 将插件具体使用说明统一收口到 Docs 文档
  • 提升 README 的结构清晰度和正式性

验收标准(必填)

  • IDE-Plugins README 删除与 Docs 中《CJMP 插件使用指南》重复的创建、构建、运行、调试步骤
  • README 保留插件仓库简介、构建与打包、安装插件、相关文档等核心内容
  • README 中提供指向《CJMP 插件使用指南》的文档链接

初步方案(可选)

likedislike
Gguomengwei成员
3月30日 添加了label:enhancement
Gguomengwei成员
3月30日 移除了负责人 Axing_huawei
Gguomengwei成员
3月30日 将 Gmw2012 设为负责人
Gguomengwei成员
3月30日 关联了pull request:[refactor][ide-plugins] #59 优化 README 文档结构
AAxing_huawei成员
3月31日 关闭了 issue