opensumi / docs

OpenSumi document website
https://opensumi.com
MIT License
7 stars 34 forks source link

OpenSumi 文档/案例优化计划 #85

Open erha19 opened 1 year ago

erha19 commented 1 year ago

背景

当前 OpenSumi 中存在一部分定制困难、文档缺失问题,造成新手用户在使用 OpenSumi 过程中出现功能开发无从下手的问题,在上一阶段我们统一对社区答疑往 Disscussion 进行引导,沉淀了部分 Q&A,及 OpenSumi 模块拓展案例仓库:opensumi/opensumi-module-samples,为了让文档更加友好专业,我们决定分阶段将这部分内容以文档形式沉淀至文档站中,帮助更多开发者解决开发过程中遇到的问题。

同时,我们也欢迎社区的开发者提交针对文档的需求或直接编写文档 ~

一期计划内容

新增 “自定义视图板块” 文档 #83

内容包括:

1. 视图追加类型

2. 局部样式修改

3. 内置资源介绍

新增 “模块拓展实战” 板块

opensumi/opensumi-module-samples 中沉淀的经典案例进一步进行代码解读及原理解析,内容包括:

新增 “常见问题” 板块

承接 Disscussion 内容,利用文档站更强的文档搜索能力,实现对内容的快速检索。

原则:简单问题使用总结性内容,复杂问题可以使用单独的文档内容展示。

案例优化

1. 优化 WebIDE 部署方案

参考 coder/code-server 提供一个简单的部署命令及权限校验界面,形式也可以参考 WordPress 等建站工具,提供一个部署界面。

image

相关 Issue:

2. 优化 IDE-Electron 项目每日构建流程

当前 ide-electron 项目产物相对比较简陋,可以考虑起一个新的产物名称,同时,针对每个 OpenSumi 大版本进行打包,用于后续为用户提供快速体验能力。

image

3. 纯前端版本冗余代码优化

当前纯前端 ide-startup-lite 项目存在较多的冗余实现,包括但不限于:

  1. 对无用服务的覆盖实现(框架代码结构导致)
  2. 存在部分无效资源
  3. 部分插件资源来源不清晰,没有完全开源并清晰说明来源
  4. 部分实现滞后,存在冗余实现(代码索引方案,可以采用 anycode 方案)

同时,针对三个示例项目,应该面向开发者成为一个起步模板项目,当前的命名方式也存在不统一,存在理解上的问题,建议命名为类似 electron/web/web-lite 的命名结构,同时以起步项目的标准设计及精简代码。

待补充

欢迎下面留言留下你最希望有的文档内容 ~

wglnint commented 1 year ago

当前主流后端开发,还是java占据主流,sumi的一致性我觉得比vscode做得好,但是,要作为java开发主力的话,插件需要安装的太多了,而且sumi的插件体系明显和vscode的不一致,至少在java插件的丰富度上,比较制约啊,建议sumi能出一个含有java插件的套装。甚至可以基于这个套装作为java的专属ide开发分支,可以简单的参考下vscode的https://code.visualstudio.com/docs/languages/java,他里面给出了Coding Pack for Java,包含插件的套装,伴随着插件的更新,还是能满足简单的日常开发使用的

erha19 commented 1 year ago

追加针对通用的内置服务,如 WorkbenchEditorService, IFileClientService 等内置服务的 API 使用说明

erha19 commented 1 year ago

当前 OpenSumi 文档也存在部分内容的滞后及理解问题,需要重新整理。

下周开始这部分工作

bytemain commented 6 months ago

https://github.com/opensumi/core/issues/3613#issuecomment-2109617204