-
Notifications
You must be signed in to change notification settings - Fork 16
修改格式/风格以遵循文档贡献和写作标准 #23
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
Conversation
Deploying sapling with
|
| Latest commit: |
11ca1f9
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://476016a4.sapling-8jp.pages.dev |
| Branch Preview URL: | https://misc-cleanup-1.sapling-8jp.pages.dev |
Au5 - Levity
放松 放开你心中的顾虑 那些没有处理的琐事 此刻 只需把注意力集中在呼吸上 深呼吸 气沉丹田 准备好,慢慢睁开眼睛,凝聚注意力 —— Boxplot - Tramontane
A moment a love A dream a laugh A kiss a cry -- Lost Frequencies - Sweet Disposition
I got this love, love, love that I'm dreaming about I got this love, love, love, got me singing out loud You're gonna take me higher, there's no denying You're the one, I got this love, yeah~ -- FROZT - Never Before
Markdown 中文教程 提供了对各个 Markdown 语法的介绍和例子,并且包含了语法,格式上的最佳实践,值得参考
文档的所有包名均采用 烤串命名法,同时修改了命名不当 / 错误的文件名
该死的mac大小写不敏感阿=-=
能不使用绝对路径就不使用绝对路径,除非为跨 docs 情况 参考 https://docusaurus.io/docs/markdown-features/links
|
已完成对文档内所有部分的修改,给我 1~3 天时间 final review一下(然后就可以 readt for review了( TODOs.md 里的一些 todo 会移到其他 PR 进行解决( |
|
已完成自己的final review。如对改动有任何问题,欢迎留下comment,或者通过以下联系方式私聊我讨论=w= |
docs/advance/management/money-management/investment-psychology.md
Outdated
Show resolved
Hide resolved
|
辛苦了!已经 Review,明显的问题已经标注 后面或许应该对连接符号进行规范化? 具体使用 |
| ### 时间 | ||
|
|
||
| 你有时间开服吗?很多人都希望开服其实就是把服务器开起来就可以放在那不管了,其实服务器运营所需要的时间比你想象的要多得多,并不是一个服务器的问题只需要几分钟就能解决,一些问题你可能从来没见过,你需要一点一点地搜索资料,排查问题,而这样一排查就是好几个小时,况且服务器一次可能不止出现一个问题,而且一个问题修完了就又出现另一个问题,这样一来就会耽误你大量的时间维护服务器,而且你不止需要处理服务器的技术问题,你还需要费心思给服务器进行宣传,对玩家进行管理,这些又要消耗大量的时间,而如果你不处理这些东西,服务器的情况就会急转直下,玩家需求得不到解决,玩家冲突没有人调解,服务器 bug 没有人修复,游戏体验最终烂成一坨,玩家纷纷离开。而如果你花费大量的时间来维护服务器,那么你的日常生活就会受到影响。对于一名初高中生来说,时间只会分为极其充裕和极其紧张两种:时间紧张的学生,时间安排都在学习或者未来事业相关,可能正在为中高考或者将来的职业努力,如果被 mc 服务器分散了时间,就很可能会对自己的前途造成影响,得不偿失;而时间充裕的学生当然可以给自己找点事干,来开 mc 服务器也没什么。对于一名大学生研究生来说,平时的课业是无论如何都要重视的 (如果你完全不担心毕业和工作那另说),此外一些人可能因为自己的职业原因,比如必须要考英语四六级、计算机二级、考公、考驾照、考会计证、考教资这些,如果因为 mc 服务器耽误了时间,那么也是会对自己的前途造成很大影响,也是得不偿失。而对于已经工作的人来说,如果工作不忙那当然可以来开服,如果工作很忙,那开服一样地会耽误工作。很多时候你认为 mc 服务器是你自己的一个爱好,但是这个爱好是需要条件的,你需要投入大量的时间和精力到里面,你需要考虑 mc 服务器和自己生活是否冲突,并不是说开就开的。时间还和资金不一样,用不太多的钱一样可以开好服务器,**但是没有大把的时间是一定开不出好服务器的。** | ||
| 你有时间开服吗?很多人都希望开服其实就是把服务器开起来就可以放在那不管了,其实服务器运营所需要的时间比你想象的要多得多,并不是一个服务器的问题只需要几分钟就能解决,一些问题你可能从来没见过,你需要一点一点地搜索资料,排查问题,而这样一排查就是好几个小时,况且服务器一次可能不止出现一个问题,而且一个问题修完了就又出现另一个问题,这样一来就会耽误你大量的时间维护服务器,而且你不止需要处理服务器的技术问题,你还需要费心思给服务器进行宣传,对玩家进行管理,这些又要消耗大量的时间,而如果你不处理这些东西,服务器的情况就会急转直下,玩家需求得不到解决,玩家冲突没有人调解,服务器 bug 没有人修复,游戏体验最终烂成一坨,玩家纷纷离开。而如果你花费大量的时间来维护服务器,那么你的日常生活就会受到影响。对于一名初高中生来说,时间只会分为极其充裕和极其紧张两种:时间紧张的学生,时间安排都在学习或者未来事业相关,可能正在为中高考或者将来的职业努力,如果被 MC 服务器分散了时间,就很可能会对自己的前途造成影响,得不偿失;而时间充裕的学生当然可以给自己找点事干,来开 MC 服务器也没什么。对于一名大学生研究生来说,平时的课业是无论如何都要重视的 (如果你完全不担心毕业和工作那另说),此外一些人可能因为自己的职业原因,比如必须要考英语四六级、计算机二级、考公、考驾照、考会计证、考教资这些,如果因为 MC 服务器耽误了时间,那么也是会对自己的前途造成很大影响,也是得不偿失。而对于已经工作的人来说,如果工作不忙那当然可以来开服,如果工作很忙,那开服一样地会耽误工作。很多时候你认为 MC 服务器是你自己的一个爱好,但是这个爱好是需要条件的,你需要投入大量的时间和精力到里面,你需要考虑 MC 服务器和自己生活是否冲突,并不是说开就开的。时间还和资金不一样,用不太多的钱一样可以开好服务器,**但是没有大把的时间是一定开不出好服务器的。** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这里太长了,或许以后可以规定一行最长的长度,这个阅读体验非常差这部分建议去分点/分段讨论,
也没必要去提到 英语四六级、计算机二级、考公、考驾照、考会计证、考教资等太多无关内容。
* 🔥 删除没有被引用的图片 * 🔥 删除图像格式转换器脚本 `convert.py` * 🐛 恢复误删的图片
Warning
注:应涉及格式/风格修改,请仔细审核此 PR 的改动
推荐使用 Paper 的 diffs.dev 进行 review
修改现有文档中明显的不规范写作风格和格式问题,错误的专有名词拼写等等
此 PR 皆在修复格式/风格错误,并没有对专业性内容进行审阅
使用 VS Code 的
AutoCorrect和Markdownlint扩展配合手工检查进行修改格式要求参考:https://nitwikit.8aka.org/contribution/writing
进度:
此 PR 改动的大致总结
根据笨蛋文档的文档贡献格式要求,中文文档排版规范等写作规范的修改 (使用
AutoCorrect和Markdownlint扩展辅助进行)文档体系章节专有名词拼写上的问题:
点击查看所有问题
杂项更改
docs/_images/qqgroupshield.svg和<!-- -->注释添加 TODO 标识docs/advance/Linux/connect-to-server.md内warning块修复docs/start/ask-for-help.md中多余的 QQ 群跳转图片