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

docs: modify the docs to make them better #5292

Merged
merged 16 commits into from
Feb 8, 2024
Merged

Conversation

ottomao
Copy link
Contributor

@ottomao ottomao commented Jan 24, 2024

Checklist
  • npm test passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

不涉及

Description of change

类似 #5290 ,继续修改文档

利用 AI 实现的文档表达优化,主要包括:

  • 修正错别字、标点
  • 句式、表达语气、段落组织优化,让阅读更通顺
  • 个别代码和注释错误

PR 内容未经人工处理,修改准确性一般在 80% 左右,请在合并前充分审阅。

@fengmk2 fengmk2 changed the title feat: 优化文档表达 docs: 优化文档表达 Jan 24, 2024
Copy link

codecov bot commented Jan 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (d771fdf) 99.86% compared to head (d343725) 99.86%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #5292   +/-   ##
=======================================
  Coverage   99.86%   99.86%           
=======================================
  Files          36       36           
  Lines        3618     3618           
  Branches      520      520           
=======================================
  Hits         3613     3613           
  Misses          5        5           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@fengmk2 fengmk2 changed the title docs: 优化文档表达 docs: 优化中文文档表达 Jan 24, 2024
@Wai-Dung Wai-Dung changed the title docs: 优化中文文档表达 docs: modify the doc to make them better Feb 7, 2024
@Wai-Dung
Copy link
Contributor

Wai-Dung commented Feb 7, 2024

@ottomao: Thanks for your contributions!

@Wai-Dung Wai-Dung changed the title docs: modify the doc to make them better docs: modify the docs to make them better Feb 8, 2024
@Wai-Dung Wai-Dung merged commit 77b5249 into eggjs:master Feb 8, 2024
20 checks passed
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.

None yet

3 participants