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

Optimize docs wrong typo and pretty the page #945

Merged
merged 3 commits into from
Mar 7, 2025

Conversation

TianMing2018
Copy link
Contributor

Optimize docs

  1. more pretty docs without change it's meanings
    • useless zwsp/nbsp or duplicated space
    • fix typo problem like replace file.cnf to file.conf
    • add links/description to important resource/command
    • wrong words definitely against it's context eg, quote 配置中心 to registry config which should be 注册中心
  2. broken links or mismatched version links

Brief changelog

those changes within the scope #944

  • optimize docs content without against it's meanings, like this
  1. more pretty docs without change it's meanings
    • useless zwsp/nbsp or duplicated space
    • fix typo problem like replace file.cnf to file.conf
    • add links/description to important resource/command
    • wrong words definitely against it's context eg, quote 配置中心 to registry config which should be 注册中心
  2. broken links or mismatched version links

@slievrly
Copy link
Member

slievrly commented Mar 4, 2025

@TianMing2018 Thank you very much for optimizing the documentation. May I ask, were these changes checked manually or by tools?

Copy link
Member

@slievrly slievrly left a comment

Choose a reason for hiding this comment

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

LGTM

@TianMing2018
Copy link
Contributor Author

@TianMing2018 Thank you very much for optimizing the documentation. May I ask, were these changes checked manually or by tools?

checked manually(reviewed changes throw IDEA changes list). Now re-confirmed by pnpm run lint,It seems no problems.

sorry about that, I'll lint next time.

@TianMing2018
Copy link
Contributor Author

@TianMing2018 Thank you very much for optimizing the documentation. May I ask, were these changes checked manually or by tools?

By the way, I just found that I didn't used my right email. So I rebase commit message, hopefully it won't affect your code review.

@slievrly
Copy link
Member

slievrly commented Mar 7, 2025

@TianMing2018 Thank you very much for optimizing the documentation. May I ask, were these changes checked manually or by tools?

By the way, I just found that I didn't used my right email. So I rebase commit message, hopefully it won't affect your code review.

If most of the changes in this PR were done manually, wow, that's a ton of work! Seriously, huge props for grinding through it – you’re a rockstar!

@slievrly slievrly merged commit 31f98c1 into apache:docusaurus Mar 7, 2025
3 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.

2 participants