-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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: improve Chinese copywriting #6528
Comments
LGTM, let's check with the tool. |
would you like to do it? |
@juzhiyuan PTAL |
Hi @kwanhur, thanks for your suggestion! I support using a unified writing guideline, after reading https://sparanoid.com/note/chinese-copywriting-guidelines/ it looks good to me 🙌
|
Yep, I'll take part in the improving jobs. |
Lint tool I recommend autocorrect, it's binary supports to lint and fix, would be easily integrated into ci workflow. Autocorrect usage: autocorrect --help
AutoCorrect 1.5.6
Jason Lee <huacnlee@gmail.com
A linter and formatter for help you improve copywriting, to correct spaces, punctuations between CJK (Chinese, Japanese,
Korean).
USAGE:
autocorrect [FLAGS] [OPTIONS] <file>...
FLAGS:
--debug Print debug message.
--type Directly use set file type
--fix Automatically fix problems and rewrite file.
-h, --help Prints help information
--lint Lint and output problems.
-V, --version Prints version information |
LGTM, and please note:
also, check those 3 articles: |
Thx for the tips. I think we can treat autocorrect integration as staticcheck in code-lint job. |
We should probably create a style guide for APISIX. We can start with documentation so that it can remain consistent. For the English docs, we could have something similar to https://developers.google.com/style/highlights where we outline how everything should be and add details specific to the project. |
* add Chinese copywriting lint job * autocorrect fix docs/zh/latest/**/*.md * fix CHANGELOG.md conflict between markdownlint and autocorrect resolve apache#6528 Signed-off-by: kwanhur <huang_hua2012@163.com>
LGTM. Docs writers will benefit from the document style guide. |
Improved or typo fixed.
Copywriting in
docs/zh/latest
have different formats:Solution
[1]
Spacing
Punctuation
Fullwidth and halfwidth
The text was updated successfully, but these errors were encountered: