Skip to content

docs(i18n): add Spanish translations (README, CONTRIBUTING, SECURITY) - #799

Open
kmikodev wants to merge 2 commits into
jamiepine:mainfrom
kmikodev:feat/i18n-spanish-docs
Open

docs(i18n): add Spanish translations (README, CONTRIBUTING, SECURITY)#799
kmikodev wants to merge 2 commits into
jamiepine:mainfrom
kmikodev:feat/i18n-spanish-docs

Conversation

@kmikodev

@kmikodev kmikodev commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

What

Adds Spanish (es) translations of the top-level documentation as separate *.es.md files, with a reciprocal language switcher on each doc.

Why

Lowers the entry barrier for Spanish-speaking users and contributors. Complements the UI locale work (#798) so both the app and its docs are available in Spanish. Kept as a separate PR from the UI locale so each is small and easy to review.

Changes

  • README.es.md, CONTRIBUTING.es.md, SECURITY.es.md — full translations. Code blocks, commands, paths, CLI flags, brand/model names, badges and table structure are preserved; only prose is translated. The README's internal anchors point to the translated headings.
  • README.md / CONTRIBUTING.md / SECURITY.md — add an English · Español switcher line near the top so each English doc links to its Spanish counterpart (and back).
  • Drive-by fix: the "Additional Resources" entry in CONTRIBUTING linked to a non-existent docs/AUTOUPDATER_QUICKSTART.md; repointed to the actual docs/content/docs/developer/autoupdater.mdx (in both EN and ES).

Verification

  • All internal #anchor links and local file links resolve across all six files (checked programmatically).
  • No code changes; no CI build impact.

Notes

  • CHANGELOG.md left untouched — it's auto-compiled during the release workflow per the file header.
  • The docs site under docs/ (Fumadocs) and the landing page are intentionally out of scope here — localizing those needs an i18n-architecture decision and can be follow-up PRs. Happy to open an issue to align on the approach if there's interest.

Summary by CodeRabbit

  • Documentation
    • Added/updated full Spanish documentation for getting started, contributing, security, and the main project overview.
    • Updated English docs with a language selector linking to the Spanish versions.
    • Expanded README content, including REST API usage examples, MCP server overview, development guidance, and contribution/release details.
    • Added a Spanish-language security policy document and linked it from the English security page.

Adds Spanish versions of the top-level docs as separate *.es.md files,
with a reciprocal language switcher linking each English doc to its
Spanish counterpart (and back).

- README.es.md, CONTRIBUTING.es.md, SECURITY.es.md: full translations.
  Code blocks, commands, paths, CLI flags, brand/model names, badges
  and table structure preserved; only prose translated. README internal
  anchors point to the translated headings.
- README.md / CONTRIBUTING.md / SECURITY.md: add an "English · Español"
  switcher line near the top.
- Drive-by fix: the "Additional Resources" link to the auto-updater doc
  pointed to a non-existent docs/AUTOUPDATER_QUICKSTART.md; repointed to
  the actual docs/content/docs/developer/autoupdater.mdx in both EN and ES.

Verified: all internal anchors and local file links resolve in all six
files.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7fc3b9a8-849e-46f9-90c5-e39695a81d3e

📥 Commits

Reviewing files that changed from the base of the PR and between aa38b66 and 94caab8.

📒 Files selected for processing (1)
  • README.es.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.es.md

📝 Walkthrough

Walkthrough

Se añaden versiones en español de README, CONTRIBUTING y SECURITY, junto con enlaces de idioma entre las páginas en inglés y español. También se amplían secciones de uso, contribución, desarrollo y política de seguridad.

Changes

Documentación bilingüe y políticas

Layer / File(s) Summary
README inicial y enlaces de idioma
README.md, README.es.md
Se añaden selectores de idioma y se amplían la cabecera, la descripción general y las descargas del README en español.
README de funciones y referencia
README.es.md
Se desarrollan las secciones de funciones, API, MCP, pila tecnológica, desarrollo local y cierre de licencia del README en español.
CONTRIBUTING de inicio y herramientas
CONTRIBUTING.md, CONTRIBUTING.es.md
Se actualizan los enlaces de CONTRIBUTING y se añaden código de conducta, requisitos, comandos, compilación, OpenAPI, conversión de recursos, estilo y estructura del proyecto.
CONTRIBUTING de flujo y release
CONTRIBUTING.es.md
Se detallan el flujo de trabajo, las áreas de contribución, las pruebas, el proceso de pull request, el release, la solución de problemas y los recursos adicionales en español.
Política y reporte de seguridad
SECURITY.md, SECURITY.es.md
Se añaden selectores de idioma y la política de seguridad en español con versiones soportadas, reporte de vulnerabilidades y prácticas básicas.
Ciclo de divulgación y actualizaciones
SECURITY.es.md
Se documentan las consideraciones de seguridad, el cronograma de divulgación coordinada y la entrega de actualizaciones de seguridad en español.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

Soy un conejo con lápiz y voz 🐇
salté por README, guía y sol.
En ES y EN quedó el jardín,
con seguridad y rutas al fin.
¡Hop hop, Voicebox floreció por aquí!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding Spanish translations for README, CONTRIBUTING, and SECURITY docs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 markdownlint-cli2 (0.22.1)
README.es.md

markdownlint-cli2 wrapper config was not available before execution


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.es.md`:
- Around line 318-323: The README markdown examples are missing fence language
labels, leaving markdownlint MD040 active. Update the fenced blocks in the
sections containing the Claude MCP command and the directory tree to use
appropriate language tags, and make sure both affected examples are labeled
consistently so the lint warning is cleared.
- Around line 104-108: Remove the blank lines inside the blockquote in
README.es.md so the callout stays as consecutive quoted lines and satisfies
markdownlint MD028. Keep the “Ver todos los binarios”, “Linux”, and
“¿Problemas?” lines directly adjacent with no empty quoted lines between them,
preserving the existing links and text.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3a78bc65-3e15-4a9d-9734-07ab7f4c604e

📥 Commits

Reviewing files that changed from the base of the PR and between b35b909 and aa38b66.

📒 Files selected for processing (6)
  • CONTRIBUTING.es.md
  • CONTRIBUTING.md
  • README.es.md
  • README.md
  • SECURITY.es.md
  • SECURITY.md

Comment thread README.es.md
Comment on lines +104 to +108
> **[Ver todos los binarios →](https://github.com/jamiepine/voicebox/releases/latest)**

> **Linux** — Aún no hay binarios precompilados. Consulta [voicebox.sh/linux-install](https://voicebox.sh/linux-install) para las instrucciones de compilación desde el código fuente.

> **¿Problemas?** Consulta la [guía de solución de problemas](docs/content/docs/overview/troubleshooting.mdx) para incidencias comunes de instalación, generación, descarga de modelos y GPU.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Remove the blank lines inside this blockquote.

Markdownlint is already flagging MD028 here. Keeping these callouts on consecutive > lines will keep the doc lint-clean.

♻️ Proposed fix
 > **[Ver todos los binarios →](https://github.com/jamiepine/voicebox/releases/latest)**
-
 > **Linux** — Aún no hay binarios precompilados. Consulta [voicebox.sh/linux-install](https://voicebox.sh/linux-install) para las instrucciones de compilación desde el código fuente.
-
 > **¿Problemas?** Consulta la [guía de solución de problemas](docs/content/docs/overview/troubleshooting.mdx) para incidencias comunes de instalación, generación, descarga de modelos y GPU.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
> **[Ver todos los binarios →](https://github.com/jamiepine/voicebox/releases/latest)**
> **Linux** — Aún no hay binarios precompilados. Consulta [voicebox.sh/linux-install](https://voicebox.sh/linux-install) para las instrucciones de compilación desde el código fuente.
> **¿Problemas?** Consulta la [guía de solución de problemas](docs/content/docs/overview/troubleshooting.mdx) para incidencias comunes de instalación, generación, descarga de modelos y GPU.
> **[Ver todos los binarios →](https://github.com/jamiepine/voicebox/releases/latest)**
> **Linux** — Aún no hay binarios precompilados. Consulta [voicebox.sh/linux-install](https://voicebox.sh/linux-install) para las instrucciones de compilación desde el código fuente.
> **¿Problemas?** Consulta la [guía de solución de problemas](docs/content/docs/overview/troubleshooting.mdx) para incidencias comunes de instalación, generación, descarga de modelos y GPU.
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 105-105: Blank line inside blockquote

(MD028, no-blanks-blockquote)


[warning] 107-107: Blank line inside blockquote

(MD028, no-blanks-blockquote)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.es.md` around lines 104 - 108, Remove the blank lines inside the
blockquote in README.es.md so the callout stays as consecutive quoted lines and
satisfies markdownlint MD028. Keep the “Ver todos los binarios”, “Linux”, and
“¿Problemas?” lines directly adjacent with no empty quoted lines between them,
preserving the existing links and text.

Source: Linters/SAST tools

Comment thread README.es.md Outdated
Tag the previously unlabeled fences flagged by markdownlint MD040:
- 'claude mcp add voicebox ...' block -> bash
- project structure tree block -> text

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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