search

blocklet / blocklet-site

Blocklet platform and developer site and documentation
https://www.blocklet.io
Other
3 stars 0 forks source link

feat: improve blocklet bundle docs #60

Closed skypesky closed 2 years ago

skypesky commented 2 years ago

关联 Issue

related docs: https://developer.blocklet.io/docs/en/how-to/bundle

主要改动

界面截图

检查清单

skypesky commented 2 years ago

@wangshijun

我的理解是: 在 bundle 之前应该告诉用户应该准备哪些东西，哪些是必须要有的，哪些是可选的。不然 bundle 的时候，就会发现缺少一些东西，总是报错。 其次，在 bundle 的时候，如果还要用户自定义的 bundle 自己的指令的话，那么前面 blocklet create ${blocklet-name} 就全部白讲了，因为用户只会通过 bloklet create 来创建 blocklet, 而通过 blocklet create 创建的 blocklet 刚好默认就已经有直接可用的 bundle, deploy 命令了。 最后，对不同类型的 blocklet，不同类型的 repo，如何打包，已经脱离了普通 bundle （普通 bundle 就用官方的命令， npm run bundle, npm run deploy 一步到位）的范畴，似乎是 bundle 进阶的指南了。

LancelotLewis commented 2 years ago

单独从 bundle 这一功能来讲的话，可以借助 3W1H 来分析：

  1. What -> 打包功能是什么？简单介绍一下打包的工作原理
  2. Why -> 为什么需要打包？deploy 及 upload 都依赖于打包，打包能带来的作用
  3. Where -> （感觉不需要这一点）
  4. How -> 怎么去打包？
    • 链接到 Create Blocklet 中的 bundle 说明
    • 针对不同类型应用给出手动添加打包命令的说明
linchen1987 commented 2 years ago

提纲中的 “定义需要打包的文件” 是必要的，应该保留。

但是还却其他的内容。

直接使用 npm run bundle 是在 create-blocklet ， get started ，tutorial 这类文档中使用

wangshijun commented 2 years ago

那么前面 blocklet create ${blocklet-name} 就全部白讲了，因为用户只会通过 bloklet create 来创建 blocklet, 而通过 blocklet create 创建的 blocklet 刚好默认就已经有直接可用的 bundle, deploy 命令了。

实际上用不不总是全部用 create-blocklet，他可能需要把自己现有的项目转为 blocklet，那个时候就需要自己搞定 bundle script，这个文档应该能帮助其搞定这个事情。

我建议把文档结构调整为：