-
-
Notifications
You must be signed in to change notification settings - Fork 533
Minor docs updates #1641
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
Minor docs updates #1641
Conversation
|
## 模拟响应 | ||
::: | ||
|
||
## Mocking Responses |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@phk422 Just a heads up: this is one section that I wanted to exist in the Chinese documentation since this is the current recommendation. Copied the English version.
No pressure whatsoever to translate it, but just wanted your feedback: is having untranslated text in localized versions better if it’s more up-to-date information?
Or is it better to remove the section?
Would love advice going forward on the best approach (for other contributors)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@drwpow I apologize for the delayed response.
Regarding whether to keep untranslated text in the localized versions, here are my suggestions:
Do not translate specific terms: For some specialized terms, it might be more accurate and easier to understand if they are kept in English in the Chinese documentation. For example, 'Mocking Responses' can be left untranslated.
Keep the untranslated English content: If this is the latest recommendation, temporarily keeping the English text can ensure that users have access to the most up-to-date guidance. However, you can add a note in the document indicating that this section is in English and will be translated in the next update. Once you update the document, you can @ me in the PR, and I will translate it as soon as possible.
Hope this helps, and I look forward to hearing from you.
Deploying openapi-ts with
|
Latest commit: |
34b561e
|
Status: | ✅ Deploy successful! |
Preview URL: | https://3b570bab.openapi-ts.pages.dev |
Branch Preview URL: | https://docs-updates.openapi-ts.pages.dev |
Changes
Docs-only change; improves syntax highlighting using Vitepress’ fancy markdown features
How to Review
One comment for @phk422
Checklist
docs/
updated (if necessary)pnpm run update:examples
run (only applicable for openapi-typescript)