docs: refresh stale Portuguese UI labels in English docs - #469
Merged
Conversation
Several user-facing docs promised English but still quoted Portuguese button/tab labels that the i18n migration (PR #467, main@45ba1685) had already renamed to English msgids. Every label below was re-verified against src/zebtrack/locales/pt_BR/LC_MESSAGES/zebtrack.po rather than translated by hand, since some labels changed shape (not just language) during the migration. docs/wiki/2_Full_Tutorial.md: - "Configuração de Zonas" -> "Zone Configuration" - "Detectar Aquário (Auto)" -> "Detect Aquarium (Auto)" - "Templates salvos" -> ROI Templates section / Template: combobox - "Importar e Aplicar Arquivo..." -> "Import and Apply File..." - "Salvar Zonas Atuais" -> "Save Current Zones" - "Configuração Avançada" -> "Advanced Settings" - "Adicionar e Processar Novos Vídeos/Pastas" -> "Add Videos/Folders to the Project..." - "Progresso do Experimento" -> "Experiment Progress" - "Relatórios" tab -> "Processing and Reports" - "Gerar Relatório Unificado (Todos)" -> "Unified Report (All)" - "Apagar Relatórios Unificados" -> "Delete Everything" - "Geotaxis Zona 1/2" -> "Geotaxis Zone 1/2" (actual report column headers) - dropped the stale "5-step wizard (v1.7)" claim, pointed to the new first_tracking_run.md walkthrough instead docs/guides/user/arduino-bindings.md and external-trigger.md: - "Usar Arduino" -> "Use Arduino for synchronization" - "Configuração de Zonas" -> "Zone Configuration" - "Comandos Arduino por Zona" -> "Per-Zone Arduino Commands (Optional)" - "Entrar"/"Sair" -> "Enter"/"Exit" - "Adicionar / Atualizar" / "Remover" / "Limpar" -> "Add / Update" / "Remove" / "Clear" - "Testar" -> "Test" - "Modo de Gatilho Externo" -> "External Trigger Mode" - "Iniciar" -> "Start" - "Aguardando sinal externo..." -> "Waiting for external signal..." - error/warning message quotes updated to their real English msgids docs/tutorials/first_tracking_run.md was rewritten end to end (was fully Portuguese) and restructured to match the current wizard, which now has 9 possible steps split across two flows (pre-recorded: Discovery, File Selection, Physical Calibration, Automatic Design Detection, Models and Weights, Import Configuration, Confirmation; live: Discovery, Experimental Design, Live Recording Configuration, Physical Calibration, Models and Weights, Confirmation) rather than the 5-step flow it used to document. Also dropped a reference to tests/manual/wizard_release_check.py, which no longer exists. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates end-user documentation to match the post-i18n-migration UI by replacing stale Portuguese UI labels with current English labels, and by rewriting the “first tracking run” wizard walkthrough to reflect the current wizard flows.
Changes:
- Refreshes quoted UI tab/button/label text in the full tutorial and Arduino-related user guides.
- Rewrites
first_tracking_run.mdin English and restructures it around the current pre-recorded vs live wizard flows. - Updates wizard-related guidance (removes references to obsolete manual checks; points to current tests/docs).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/wiki/2_Full_Tutorial.md | Updates tutorial UI label references and wizard guidance to current English UI. |
| docs/tutorials/first_tracking_run.md | Full rewrite to an English, up-to-date wizard walkthrough including diverging flows. |
| docs/guides/user/external-trigger.md | Updates UI label references and message text for External Trigger Mode documentation. |
| docs/guides/user/arduino-bindings.md | Updates UI label references for the per-zone Arduino bindings workflow. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.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
Four user-facing docs promised English but still quoted Portuguese button/tab/message labels that the i18n migration (#467, main@45ba1685) had already renamed to English. Readers would conclude the app is broken when it's just the docs that went stale. Every label was re-verified against
src/zebtrack/locales/pt_BR/LC_MESSAGES/zebtrack.po— several changed shape, not just language, during the migration.docs/wiki/2_Full_Tutorial.md"Configuração de Zonas"→"Zone Configuration"Detectar Aquário (Auto)→Detect Aquarium (Auto)Templates salvos→ the ROI Templates section / Template: combobox📂 Importar e Aplicar Arquivo...→📂 Import and Apply File...💾 Salvar Zonas Atuais→💾 Save Current ZonesConfiguração Avançada→Advanced SettingsAdicionar e Processar Novos Vídeos/Pastas→Add Videos/Folders to the Project...Progresso do Experimento→Experiment ProgressRelatóriostab →Processing and ReportsGerar Relatório Unificado (Todos)→📚 Unified Report (All)🗑️ Apagar Relatórios Unificados→🗑️ Delete EverythingGeotaxis Zona 1/2→Geotaxis Zone 1/2(real report column headers)first_tracking_run.mdinsteaddocs/guides/user/arduino-bindings.mdanddocs/guides/user/external-trigger.md"Usar Arduino"→"Use Arduino for synchronization""Configuração de Zonas"→"Zone Configuration""Comandos Arduino por Zona"→"Per-Zone Arduino Commands (Optional)"Entrar/Sair→Enter/ExitAdicionar / Atualizar/Remover/Limpar→Add / Update/Remove/Clear"Testar"→"🔌 Test""Modo de Gatilho Externo"→"External Trigger Mode""▶️ Iniciar"→"▶️ Start""Aguardando sinal externo..."→"Waiting for external signal..."docs/tutorials/first_tracking_run.mdWas entirely in Portuguese and documented a 5-step wizard that no longer exists. Rewritten end-to-end in English and restructured to match the current wizard, which now branches into two flows:
Also dropped a reference to
tests/manual/wizard_release_check.py, which no longer exists in the repo.Test plan
src/zebtrack/locales/pt_BR/LC_MESSAGES/zebtrack.po(msgid/msgstr pairs) or the widget source directlypre-commit run --files <touched files>passes (markdownlint, mypy, etc.)docs/guides/developer/wizard.md,docs/reference/operational_reference.md,docs/explanation/architecture.md) confirmed to still existFiled a separate follow-up task for a stale-label docstring in
zone_control_builder.py(comment only, out of scope here).Co-Authored-By: Claude Sonnet 5 noreply@anthropic.com