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

Add Spanish Translation for Documentation README (docs/README_es.md) #1592

Closed
salazarsebas opened this issue Dec 31, 2024 · 2 comments
Closed
Labels
enhancement New feature or request

Comments

@salazarsebas
Copy link
Contributor

Describe the solution you'd like

We need to create a Spanish version of our documentation README to make elizaOS more accessible to Spanish-speaking developers and users. This translation will help expand our international community and provide better support for Spanish-speaking contributors.

Tasks

  1. Create a new file README_es.md in the docs directory
  2. Translate all existing sections from the English README including:
    • Project overview and introduction
    • Installation instructions
    • Configuration steps
    • Basic usage examples
    • Contributing guidelines
    • License information

Additional context

Technical Requirements:

  • Maintain all existing Markdown formatting and structure
  • Keep all code examples unchanged (comments should be translated)
  • Preserve all links and references, updating them if they point to Spanish versions when available
  • Include a language selector at the top of the document linking to other language versions
  • Follow Spanish technical writing conventions and terminology

Quality Guidelines:

  • Use formal Spanish suitable for technical documentation
  • Ensure terminology consistency throughout the document
  • Avoid literal translations that might not convey the correct technical meaning
  • Have the translation reviewed by a native Spanish speaker with technical background

Additional Notes:

  • Reference the original English README.md for structure and content
  • Update the main README.md to include a link to the Spanish version
  • Consider adding metadata for language detection
  • Document any Spanish-specific resources or community channels if available

Deliverables:

  • Complete README_es.md file
  • Updated links in the main README.md
  • Documentation of any translation decisions made for future reference
@salazarsebas salazarsebas added the enhancement New feature or request label Dec 31, 2024
Copy link
Contributor

Hello @salazarsebas! Welcome to the ai16z community. Thank you for opening your first issue; we appreciate your contribution. You are now a ai16z contributor!

@shakkernerd
Copy link
Member

Implemented in #1594

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants