Skip to content

添加了档案编辑和多周轮换页面#69

Open
rukaax wants to merge 19 commits intoClassIsland:mainfrom
rukaax:main
Open

添加了档案编辑和多周轮换页面#69
rukaax wants to merge 19 commits intoClassIsland:mainfrom
rukaax:main

Conversation

@rukaax
Copy link
Copy Markdown

@rukaax rukaax commented Apr 4, 2026

No description provided.

Copy link
Copy Markdown
Member

@HelloWRC HelloWRC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. 指示文本应该整行粗体,例如:
    **👉 Do sth**
  2. 写完记得跑一下 markdownlint,优化一下格式

此外,新增的文档还缺少一些关键的解释性内容。可以参考应用内教程的文本进行补充。

rukaax added 2 commits April 4, 2026 18:19
补充了一些必要的解释
移除了某些不必要的操作提示
@rukaax
Copy link
Copy Markdown
Author

rukaax commented Apr 4, 2026

已全部纠正

@rukaax rukaax requested a review from HelloWRC April 4, 2026 10:24
Copy link
Copy Markdown
Member

@HelloWRC HelloWRC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

请注意修正格式错误:

  • 每段之间应有两个换行,而本文大部分的分段只有一个换行
  • 指引的“👉”emoji 与正文应有空格。
  • 为图片补齐描述

此外,您还要注意此文档是面向初学者编写的,应该避免出现对初学者有门槛的内容,并且对于如“时间表-课表关系”等抽象概念应该配有 mermaid 图示讲解,而非应用内截图。

@HelloWRC
Copy link
Copy Markdown
Member

HelloWRC commented Apr 4, 2026

另外别忘了合并上游。

@rukaax rukaax requested a review from HelloWRC April 4, 2026 13:23
Copy link
Copy Markdown
Member

@HelloWRC HelloWRC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

草,我感觉您好像理解错了我的意思。

我说的“两个换行”指的是“两个换行符”,也就是这样的:

xxxxxx

xxxxxx

此外:

  • 除了列表以外不要大面积使用段内换行,这样会降低可读性。该分段的地方就直接分段,图片非必要应该单独成段,不要段内换行。
  • 中文与英文之间都应该有空格。建议使用 vs code 中的插件 AutoCorrect 自动进行此格式化。
  • 图片应该补全替代文本。
  • 代表按钮的文本都应该用”【】“包围而非使用引号包围。例如:点击【添加】按钮。

有的操作对开发者而言可能是理所当然的,但对新用户而言可能不是。在编写教程时不要省略这些操作。

rukaax added 2 commits April 5, 2026 22:23
- 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]
@rukaax rukaax reopened this Apr 5, 2026
@rukaax rukaax requested a review from HelloWRC April 5, 2026 14:31
@rukaax
Copy link
Copy Markdown
Author

rukaax commented Apr 5, 2026

好的文档已经全部纠正

@rukaax rukaax requested a review from HelloWRC April 5, 2026 15:39
Copy link
Copy Markdown
Member

@HelloWRC HelloWRC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

写完记得完整读一遍,看看文档:

  • 有没有逻辑上不连贯的地方
  • 有没有地方缺少解释,容易让新人读完云里雾里

@rukaax rukaax requested a review from HelloWRC April 6, 2026 22:01
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.

2 participants