Open
Conversation
HelloWRC
requested changes
Apr 4, 2026
Author
|
已全部纠正 |
HelloWRC
requested changes
Apr 4, 2026
Member
HelloWRC
left a comment
There was a problem hiding this comment.
请注意修正格式错误:
- 每段之间应有两个换行,而本文大部分的分段只有一个换行
- 指引的“👉”emoji 与正文应有空格。
- 为图片补齐描述
此外,您还要注意此文档是面向初学者编写的,应该避免出现对初学者有门槛的内容,并且对于如“时间表-课表关系”等抽象概念应该配有 mermaid 图示讲解,而非应用内截图。
Member
|
另外别忘了合并上游。 |
HelloWRC
requested changes
Apr 5, 2026
Member
There was a problem hiding this comment.
草,我感觉您好像理解错了我的意思。
我说的“两个换行”指的是“两个换行符”,也就是这样的:
xxxxxx
xxxxxx此外:
- 除了列表以外不要大面积使用段内换行,这样会降低可读性。该分段的地方就直接分段,图片非必要应该单独成段,不要段内换行。
- 中文与英文之间都应该有空格。建议使用 vs code 中的插件 AutoCorrect 自动进行此格式化。
- 图片应该补全替代文本。
- 代表按钮的文本都应该用”【】“包围而非使用引号包围。例如:点击【添加】按钮。
有的操作对开发者而言可能是理所当然的,但对新用户而言可能不是。在编写教程时不要省略这些操作。
- Add blank lines around fenced code blocks in README.md - Add markdownlint-cli2 as dev dependency 🤖 Generated with [Qoder][https://qoder.com]
…-docs-next - Add outro chapter - Complete component editing tutorial - Move deploy.md to setup.md - Update contributing guidelines - Complete basic concepts section 🤖 Generated with [Qoder][https://qoder.com]
Author
|
好的文档已经全部纠正 |
HelloWRC
requested changes
Apr 5, 2026
HelloWRC
reviewed
Apr 6, 2026
Member
HelloWRC
left a comment
There was a problem hiding this comment.
写完记得完整读一遍,看看文档:
- 有没有逻辑上不连贯的地方
- 有没有地方缺少解释,容易让新人读完云里雾里
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.