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

docs: optimization the README.md #1149

Merged
merged 13 commits into from
Jul 6, 2021
Merged

docs: optimization the README.md #1149

merged 13 commits into from
Jul 6, 2021

Conversation

ymh199478
Copy link
Member

@ymh199478 ymh199478 commented Jul 4, 2021

提交优化了 README.md,主要调整如下:

  • 调整了 Feature 的描述,使描述具备超链接到对应文档中,并统一合并到 About Kratos 区块
  • 调整了 Getting Started 的描述,确保用户可以不用考虑什么东西直接根据指引就能的启动 kratos 程序
  • 新增 Security Vulnerabilities 区域用于指示安全性问题的报告方式,@tonybase 请确认下报告地址
  • 原 Related 区块描述的内容,被整合到 Learning Kratos 区块中, FQA 由于文档连接丢失已经移除
  • Conventional commits 区块的内容被聚合到 Contributors 区块中,不再直接显示
  • 新增了带有 padding 20px 的 logo 图,用于扩大拥挤的空间,使页面具备一定呼吸感

Logo 图丢失问题由于我的超链接是指向的主仓库,主仓库没有本次提交的文件,所以找不到图,等合并进去后就会恢复了。

效果

可以到:https://github.com/ymh199478/kratos/blob/main/README.md 看效果


请合并 commit 进行 merge

@longXboy longXboy merged commit 02e8bf6 into go-kratos:main Jul 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants