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

doc(i18n): translate some extra stuff #423

Merged
merged 2 commits into from
Jan 15, 2025
Merged

Conversation

peter-jerry-ye
Copy link
Collaborator

@peter-jerry-ye peter-jerry-ye commented Jan 15, 2025

Translate author & modify environment for easier use.

Copy link

peter-jerry-ye-code-review bot commented Jan 15, 2025

‼️ This code review is generated by a bot. Please verify the content before trusting it.

Here are three observations and potential issues from the provided git diff:

  1. Environment Variable Change (SPHINXOPTS to LANGUAGE):

    • The environment variable SPHINXOPTS has been replaced with LANGUAGE in both the document.code-workspace and next/README.md files. This change might cause issues if the build system or scripts still expect SPHINXOPTS to be set. Ensure that all dependent scripts and configurations are updated to use LANGUAGE instead of SPHINXOPTS.
  2. Inconsistent Language Variable Handling:

    • In next/conf.py, the code checks for both READTHEDOCS_LANGUAGE and LANGUAGE environment variables. However, the format of the language code differs (zh-cn vs. zh_CN). This inconsistency could lead to unexpected behavior. Ensure that the language codes are consistent across the codebase to avoid confusion.
  3. Hardcoded Project and Author Names:

    • The project name and author are hardcoded differently for Chinese and English versions in next/conf.py. While this might be intentional, it could lead to maintenance challenges if the project name or author changes. Consider using a more dynamic approach or configuration files to manage these values, especially if they are subject to frequent changes.

These issues should be reviewed and addressed to ensure consistency and maintainability in the codebase.

@peter-jerry-ye peter-jerry-ye force-pushed the zihang/improve-i18n branch 6 times, most recently from a2c765d to 7d74a5d Compare January 15, 2025 07:46
@peter-jerry-ye peter-jerry-ye merged commit 5a8be8a into main Jan 15, 2025
4 checks passed
@peter-jerry-ye peter-jerry-ye deleted the zihang/improve-i18n branch January 15, 2025 08:16
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.

1 participant