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

chore: Reorganizing README translations into a dedicated i18n directory structure #2149

Merged
merged 8 commits into from
Jan 16, 2025

Conversation

0xnogo
Copy link
Contributor

@0xnogo 0xnogo commented Jan 11, 2025

Relates to

#2210

Reorganizing README translations into a dedicated i18n directory structure

Risks

Low - This is primarily a documentation organization change that:

  • Updates file paths for translations
  • Updates GitHub workflow output paths
  • No code functionality changes

Background

What does this PR do?

  1. Creates a new i18n/readme/ directory structure for README translations
  2. Updates the main README.md translation links to point to the new directory
  3. Updates the GitHub workflow to output translations to the new directory
  4. Improves project root directory organization

What kind of change is this?

Improvements (reorganization of existing documentation structure)

Documentation changes needed?

My changes require a change to the project documentation:

  • Updated all translation links in main README.md
  • Updated GitHub workflow configuration for translation generation
  • Created new directory structure for translations

Testing

Where should a reviewer start?

  1. Check the updated README.md translation links
  2. Verify the GitHub workflow configuration changes
  3. Ensure translations are being generated in the correct directory

Detailed testing steps

  1. Run the README translation workflow
  2. Verify translations are generated in i18n/readme/ directory
  3. Verify all links in main README.md work correctly
  4. Check that the commit action still works with the new file paths

Deploy Notes

After merging:

  1. The next translation workflow run will create the i18n/readme directory if it doesn't exist
  2. All new translations will be generated in the new directory structure

@0xnogo 0xnogo changed the base branch from main to develop January 11, 2025 10:27
@0xnogo 0xnogo changed the title Ng/moving-readmes Reorganizing README translations into a dedicated i18n directory structure Jan 11, 2025
@tcm390
Copy link
Collaborator

tcm390 commented Jan 12, 2025

hi @0xnogo could you resolve the conflict

- Introduced new language translations for Eliza in Arabic, Chinese, German, Spanish, French, Hebrew, Hungarian, Italian, Japanese, Korean, Dutch, Polish, Portuguese, Romanian, Russian, Serbian, Tagalog, Thai, Turkish, and Vietnamese.
- Updated the README structure to include links to the new translations.
- Added a new plugin '@elizaos/plugin-hyperliquid' in the pnpm-lock.yaml file with its dependencies.
- Adjusted the README links to point to the correct paths for translations.
@0xnogo 0xnogo force-pushed the ng/moving-readmes branch from eda1ec2 to 79a9650 Compare January 15, 2025 06:21
@tcm390
Copy link
Collaborator

tcm390 commented Jan 16, 2025

we don't need this one? README_FARSI.md

@0xnogo
Copy link
Contributor Author

0xnogo commented Jan 16, 2025

README_FARSI.md represents the same language as README_FA.md and is not following the Language Code (ISO 639-1): https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes. Hence, I decided to remove and keep the one following the standard language code.

@odilitime odilitime changed the title Reorganizing README translations into a dedicated i18n directory structure chore: Reorganizing README translations into a dedicated i18n directory structure Jan 16, 2025
@odilitime odilitime merged commit 6914be3 into elizaOS:develop Jan 16, 2025
7 of 8 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.

3 participants