docs(i18n): make README English-source, split PT into README.pt-BR.md - #468
Merged
Conversation
CLAUDE.md declares English as the source language for technical docs, but README.md was never migrated — it stayed the sole entry point in Portuguese. README.md is now the English original; README.pt-BR.md preserves the full Portuguese content, with cross-links between the two at the top. UI labels referenced in the English README (tab names, Arduino Dashboard) were verified against the pt_BR gettext catalogue rather than translated by eye. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
docs/wiki/INDEX.md was the last Portuguese-only index; translate it to English per the docs/wiki convention (Portuguese lives in the individual wiki pages, not the index). File paths in links are unchanged — only the prose is translated. docs/INDEX.md claimed version 4.1.0 but pyproject.toml is still 4.0.0; align the two rather than inventing a new number (pyproject bump is a separate release chore, out of scope here). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Aligns repository entry-point documentation with the project’s i18n convention (English as the source language for technical docs), while preserving the full Portuguese README as a separate, linked variant.
Changes:
- Migrates
README.mdto an English-source README and adds cross-linking to the Portuguese version. - Adds
README.pt-BR.mdas the full Portuguese counterpart (with cross-link back to English). - Translates
docs/wiki/INDEX.mdto English and corrects the version string indocs/INDEX.md.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | English-source README with link to Portuguese version. |
| README.pt-BR.md | Portuguese README counterpart with link back to English. |
| docs/wiki/INDEX.md | English translation of the wiki index while keeping link targets unchanged. |
| docs/INDEX.md | Version string corrected to match pyproject.toml. |
Suppressed comments (2)
README.md:771
- The README recommends using
EventBus, but the project’s current event system isEventBusV2(the legacy EventBus v1 was deleted). Updating the name here keeps the contribution guidelines aligned with the actual API.
- ✅ **Event-Driven**: prefer communication via `EventBus`
README.pt-BR.md:763
- Aqui o guia recomenda comunicação via
EventBus, mas o sistema de eventos atual éEventBusV2. Ajustar o nome evita confusão para contribuidores.
- ✅ **Event-Driven**: Prefira comunicação via `EventBus`
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| v4.0 represents a fundamental rewrite of the system, focused on stability, maintainability, and performance: | ||
|
|
||
| - **🏗️ Event-Driven Architecture**: complete refactor to eliminate direct coupling between components | ||
| - Event system with `EventBus` for asynchronous communication |
| A v4.0 representa uma reescrita fundamental do sistema com foco em estabilidade, manutenibilidade e performance: | ||
|
|
||
| - **🏗️ Arquitetura Event-Driven**: Refatoração completa para eliminar acoplamento direto entre componentes | ||
| - Sistema de eventos com `EventBus` para comunicação assíncrona |
Copilot's PR review caught that the Contributing/Code Guidelines section told contributors to use `EventBus`, but that class was removed — EventBusV2 is the sole event bus (CLAUDE.md:383). Fix in both language versions. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CLAUDE.md declares English as the source language for technical docs ("Technical docs are English;
docs/wiki/keeps Portuguese alongside the English pages"), butREADME.md— the repo's GitHub entry point — was never migrated and stayed entirely in Portuguese. This is the fourth, independent front of the ongoing i18n consolidation (does not depend on or touch files from the parallel session fixing stale UI labels indocs/wiki/,docs/guides/user/,docs/tutorials/).README.mdis now the English original — a complete, faithful translation of the previous Portuguese content (no sections cut or summarized).README.pt-BR.mdpreserves the previous Portuguese content in full, with a link back to the English README at the top.msgids insrc/zebtrack/locales/pt_BR/LC_MESSAGES/zebtrack.po(viatab_builder.py/analysis_widgets.py/arduino_dashboard.py), not translated by eye — all matched the existing Portuguese wording exactly.docs/wiki/INDEX.mdtranslated to English (the Portuguese lives in the individual wiki pages per thedocs/wiki/convention, not the index itself). File names in links (1_Installation.md,2_Full_Tutorial.md, etc.) are unchanged.docs/INDEX.md: fixed**Version:** 4.1.0→4.0.0to matchpyproject.toml(still4.0.0), rather than inventing a new number.Out of scope (flagged, not touched)
version-4.0.0badge inREADME.md/README.pt-BR.mdand thepyproject.tomlversion itself — separate release chore.docs/links in the README's "Full Documentation" section point at pre-Diátaxis paths that no longer exist (e.g.docs/architecture/ARCHITECTURE.md,docs/guides/developer/DEVELOPER_GUIDE.md,README_TESTS.md). These were already broken before this split — preserved as-is in both language versions since fixing them is a content-accuracy task, not a translation task.Test plan
pre-commit run --files README.md README.pt-BR.md docs/INDEX.md docs/wiki/INDEX.md— markdownlint and all other hooks pass.README.mdend-to-end — no leftover Portuguese.README.pt-BR.md(860 lines) matches the originalREADME.md(858 lines) plus the two added link lines — confirms it's a full copy, not a summary.mypy .and the push hooks pass (worktree env sourced viascripts/wt-env.sh).🤖 Generated with Claude Code