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

fix(Officialqq):完善官方机器人对接相关文档 #279

Merged
merged 19 commits into from
Oct 11, 2024

Conversation

cherrybird7
Copy link
Contributor

有一说一,企鹅的官方文档漏洞真的很大,然后很多功能也处于待开发阶段。关于如何让官方机器人发生图片,我目前没做过多的研究。希望大家自行补充。

@Xiangze-Li Xiangze-Li requested a review from a team October 11, 2024 09:39
@kenichiLyon kenichiLyon changed the title 完善了海豹配置官方机器人的流程,争取手把手解决大家的困惑 fix(Officialqq):完善官方机器人对接相关文档 Oct 11, 2024
@MintCider
Copy link
Contributor

自己检查一下用语,再核对一遍,好多地方太口语化不够书面,还有错字漏字

Copy link
Contributor

@kenichiLyon kenichiLyon left a comment

Choose a reason for hiding this comment

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

更改了部分措辞。请依照action中 markdownlint 报错与 @Xiangze-Li 评论区中提及的中文排版指南进行修改。
措辞可参考其他文件,目前教程措辞相对口语化。可根据本人的comment或手册仓库其他教程再修改。辛苦。

@cherrybird7
Copy link
Contributor Author

敬请按照 中文文案排版指北 的要求在文段中规范使用空格和标点,按照 markdownlint 的要求修正 MarkDown 格式,并且改正错字(如「投点」应作「骰点」,其余恕不一一列举)。

已经按照手册进行了修改,对已对文章进行了更进一步的校对。解决了一些句子过于口语化问题,提高了文章的易读性,完成了@kenichiLyon大部分的要求。此外再补充了一张示例图片。

修复了一些bug,应该可以正常合并了
@cherrybird7
Copy link
Contributor Author

修复了一些bug,应该可以正常合并了

Copy link
Contributor

@kenichiLyon kenichiLyon left a comment

Choose a reason for hiding this comment

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

措辞有可改进的空间。后续由 @sealdice/manual-team 成员接手进行维护。暂不approve。

docs/deploy/platform-qq.md Show resolved Hide resolved
docs/deploy/platform-qq.md Outdated Show resolved Hide resolved
docs/deploy/platform-qq.md Outdated Show resolved Hide resolved
docs/deploy/platform-qq.md Outdated Show resolved Hide resolved
@JustAnotherID
Copy link
Collaborator

JustAnotherID commented Oct 11, 2024

@cherrybird7

  1. 资源文件应该直接保存在仓库中,不要依赖如百度云盘等的第三方付费服务。
  2. 如何添加 bot 到群聊中,不属于部署文档应当包含的内容,仅需简单提及即可。
  3. 自己无法确认的传言等内容不应该在官方文档提及。
  4. 所有提示内容最好完整补充原因,不要不加说明的进行提示。
  5. 提交前建议在本地检查文档内容是否能正常和良好展示,包括 pc 端和手机端。存在很多图片展示过大或过小的问题。
  6. 每张图片在文档中引用时,都要用文字说明图片表示的内容(即 alt 中的文本),这是提供给弱网环境图片无法加载的占位文字,以及提供给屏幕阅读器等无障碍访问工具的内容。
  7. 善用 vitepress 提供的注释样式。
  8. 部分内容的措辞还需要优化,作为文档应该使用更加书面的表达。

上面的问题我直接进行调整和修改了,看其他人还有没有调整建议。 @Xiangze-Li @kenichiLyon

kenichiLyon
kenichiLyon previously approved these changes Oct 11, 2024
Copy link
Contributor

@kenichiLyon kenichiLyon left a comment

Choose a reason for hiding this comment

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

LGTM

@Xiangze-Li Xiangze-Li merged commit dd1dc06 into sealdice:main Oct 11, 2024
1 check passed
Copy link
Contributor

@oissevalt oissevalt left a comment

Choose a reason for hiding this comment

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

LGTM

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.

6 participants