Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[讨论] 能不能从 create-blocklet 创建项目 REAMD 中移除 "File Structure" 这一节 #230

Open
polunzh opened this issue Oct 17, 2022 · 5 comments
Assignees
Labels
Milestone

Comments

@polunzh
Copy link
Contributor

polunzh commented Oct 17, 2022

如下图,感觉这部分内容没什么用,而且又比较长,影响阅读。

image

@wangshijun
Copy link
Collaborator

这个 readme 可以把大部分内容链接到 createblocklet 的站点文档里面

@wangshijun wangshijun added this to the 2022 W44 milestone Oct 30, 2022
@frmachao
Copy link
Contributor

frmachao commented Nov 4, 2022

不同模板中的目录结构可能有些不同,我感觉放到 readme 中还好,因为在 https://www.createblocklet.dev/docs/en/templates 中我们有对 模板做简单介绍,而 readme 文件是用户通过 create blocklet 创建出项目后才能看到的详细内容

@wangshijun
Copy link
Collaborator

建议去掉,项目 readme 里面可以放更多文档链接,文档是可以更新的,而生成的项目没法更新

@frmachao
Copy link
Contributor

frmachao commented Nov 4, 2022

检查了现在 templates 目录中的所有的 readme,很多内容可以替换成文档链接,比如 bundle deploy upload

image

@wangshijun
Copy link
Collaborator

都更新下吧

@LancelotLewis LancelotLewis modified the milestones: 2022 W44, 2022 W45 Nov 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants