Skip to content
New issue

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

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

Already on GitHub? # to your account

文档语法规范化 #120

Merged
merged 3 commits into from
Apr 4, 2022
Merged

文档语法规范化 #120

merged 3 commits into from
Apr 4, 2022

Conversation

yukiiiteru
Copy link
Contributor

这一 Pull Request 主要做了以下工作:

  • 使用空格分隔中英文字符
  • 修复专有名词拼写问题
  • 解决部分 Markdown 语法问题
  • 将正文中过长的链接放至正文下方
  • 移除了链接中无用的后缀
  • [课程网站](链接) 的形式修改为以下形式:
    • 课程网站: [网站标题](链接)
    • 课程网站: <链接>
  • [这个GitHub仓库](链接) 的形式修改为 [用户名/仓库](链接) 的形式

时间有限,可能还有不够完善的地方,希望大家可以批评指正。

Reference: #114

This commit does the following things:

- Separate Chinese and English by a space
- Fix proper nouns
- Fix syntax problems of Markdown
- Move long links below
- Remove unnecessary suffix of links

Signed-off-by: Yukiteru <wfly1998@sina.com>
This commit does the following things:

- Change `[Course Web](link)` to:
  - `Course Web: [title](link)`, or
  - `Course Web: <link>`
- Change `[This GitHub](link)` to `[user/repo](link)`

Signed-off-by: Yukiteru <wfly1998@sina.com>
Signed-off-by: Yukiteru <wfly1998@sina.com>
@yukiiiteru
Copy link
Contributor Author

另外,我本来想在文档中加入清华大学的操作系统课程及其 uCore 和 rCore-Tutorial 实验。但由于 uCore 仓库已停止维护,且 rCore-Tutorial 较先前版本改动太大,导致我对最新版本了解不够充分,因此先不加入相关文档了。

@PKUFlyingPig PKUFlyingPig merged commit da03694 into PKUFlyingPig:master Apr 4, 2022
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants