Develop ESP translation by westoleaboat · Pull Request #750 · selfcustody/krux

westoleaboat · 2025-10-24T15:11:42Z

What is this PR for?

Translation of docs in Spanish

Changes made to:

Code
Tests
Docs
CHANGELOG

Did you build the code and tested on device?

Yes, build following instructions and tested running mkdocs serve

What is the purpose of this pull request?

Bug fix
New feature
Docs update
Other

tadeubas · 2025-11-08T00:39:07Z

Hi @westoleaboat , what do you think about merging this now to bring in the new theme and other updates? That way, everyone can already see what’s been done in Spanish - and if they notice anything missing or still in English, it might encourage more contributions. Otherwise, I’m afraid this PR might take quite a while...

westoleaboat · 2025-11-11T01:30:29Z

hi @tadeubas yes we should do it.

tadeubas · 2025-11-12T15:38:25Z

Opened (another 😄) PR to you: westoleaboat#4

codecov · 2025-11-22T17:24:18Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.37%. Comparing base (e6b895e) to head (7789a79).
⚠️ Report is 16 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop     #750   +/-   ##
========================================
  Coverage    97.37%   97.37%           
========================================
  Files           83       83           
  Lines        10525    10534    +9     
========================================
+ Hits         10249    10258    +9     
  Misses         276      276

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

odudex · 2025-11-24T17:31:09Z

Thank you for you hard work so far guys. Docs are looking great.
To add the translation infra-structure, it would be good to have at least all the installation methods and basic usage fully translated.

qlrd

Some nits about src=" /krux/img attribute on html stuffs. This creates unecessary diff and is out of the scope of the PR change the src attribute. Please revert it to relative path.

Also, I think this PR is still in Draft process, so could be better to change its visibility.

qlrd · 2025-12-05T17:17:37Z

docs/getting-started/features/QR-transcript-tools.en.md

 ### Standard Mode
-<img src="../../../img/maixpy_m5stickv/standard-qr-code-250.png" align="right" class="m5stickv">
-<img src="../../../img/maixpy_amigo/standard-qr-code-300.png" align="right" class="amigo">
+<img src="/krux/img/maixpy_m5stickv/standard-qr-code-250.png" align="right" class="m5stickv">


Why the change? IMO this could be potentially be problematic depending on developer's machine.

I've explained before in our Telegram chat: using those paths would break links in the Spanish version because its URLs include the /es/ prefix. Also the relative paths were messy... if we move a document to a different location would break all the links.

Whether the paths are relative or absolute doesn’t affect how the image is displayed; it will render normally either way, it doesn't depend on developer's machine or our site generate by GitHub actions

qlrd · 2025-12-05T17:17:53Z

docs/getting-started/features/QR-transcript-tools.en.md

+<img src="/krux/img/maixpy_m5stickv/lines-qr-code-250.png" align="right" class="m5stickv">
+<img src="/krux/img/maixpy_amigo/lines-qr-code-300.png" align="right" class="amigo">

 If you are good at transcribing things like handwritten text, with this mode one QR code line will be highlighted at a time. Press `ENTER` to highlight the next line.

 <div style="clear: both"></div>

 ### Zoomed Regions Mode
-<img src="../../../img/maixpy_m5stickv/zoomed-qr-code-250.png" align="right" class="m5stickv">
-<img src="../../../img/maixpy_amigo/zoomed-qr-code-300.png" align="right" class="amigo">
+<img src="/krux/img/maixpy_m5stickv/zoomed-qr-code-250.png" align="right" class="m5stickv">
+<img src="/krux/img/maixpy_amigo/zoomed-qr-code-300.png" align="right" class="amigo">


qlrd · 2025-12-05T17:18:10Z

docs/getting-started/features/QR-transcript-tools.en.md

+<img src="/krux/img/maixpy_m5stickv/grided-qr-code-250.png" align="right" class="m5stickv">
+<img src="/krux/img/maixpy_amigo/grided-qr-code-300.png" align="right" class="amigo">

 Grids will be added to a standard QR code. In a dark room, if you place a sheet of paper over the device's screen, you'll notice QR code will be visible and it will be possible to copy it directly from above (tracing). Be careful not to damage your screen with pen and markers, use an insulating plastic tape or film to protect the device when using this method.

 <div style="clear: both"></div>

 ### QR Viewer
-<img src="../../../img/maixpy_m5stickv/qr-viewer-250.png" align="right" class="m5stickv">
-<img src="../../../img/maixpy_amigo/qr-viewer-300.png" align="right" class="amigo">
+<img src="/krux/img/maixpy_m5stickv/qr-viewer-250.png" align="right" class="m5stickv">
+<img src="/krux/img/maixpy_amigo/qr-viewer-300.png" align="right" class="amigo">


qlrd · 2025-12-05T17:18:20Z

docs/getting-started/features/encryption/encryption.en.md

+<img src="/krux/img/maixpy_m5stickv/load-mnemonic-kef-via-qr-250.png" align="right" class="m5stickv">
+<img src="/krux/img/maixpy_amigo/load-mnemonic-kef-via-qr-300.png" align="right" class="amigo">


qlrd · 2025-12-05T17:18:29Z

docs/getting-started/features/mnemonic-xor.en.md


-<img src="../../../img/mnemonic_xor.png" align="center">
+<img src="/krux/img/mnemonic_xor.png" align="center">


qlrd · 2025-12-05T17:21:15Z

docs/getting-started/index.es.md

@@ -0,0 +1,23 @@
+<img src="/krux/img/krux-devices.jpg" style="width: 40%; min-width: 260px;" class="align-right">


qlrd · 2025-12-05T17:21:34Z

docs/getting-started/installing/from-gui/index.en.md

 official desktop application, **Krux-Installer**:

-[<img src="../../../img/badge_github.png" width="186">](https://github.com/selfcustody/krux-installer/releases)
+[<img src="/krux/img/badge_github.png" width="186">](https://github.com/selfcustody/krux-installer/releases)


qlrd · 2025-12-05T17:21:47Z

docs/getting-started/installing/from-gui/index.es.md

@@ -0,0 +1,15 @@
+Puedes instalar Krux (ambos la versión oficial o beta) en tu dispotivo con chip K210 utilizando nuestra aplicación oficial para computador, **Krux-Installer**:
+
+[<img src="/krux/img/badge_github.png" width="186">](https://github.com/selfcustody/krux-installer/releases)


qlrd · 2025-12-05T17:22:18Z

docs/getting-started/installing/from-gui/usage.en.md

 After choose `odudex/krux_binaries`, you'll be warned with a message:

-<img width="640" src=" ../../../../img/krux-installer/warn_beta.png" alt="Krux-Installer warning beta version" />
+<img width="640" src=" /krux/img/krux-installer/warn_beta.png" alt="Krux-Installer warning beta version" />


qlrd · 2025-12-05T17:22:30Z

docs/getting-started/installing/from-gui/usage.en.md

 At startup, **Krux-Installer** recognize the locale used in your system. If your language isn't supported, it will defaults to `en_US`.

-<img width="640" src=" ../../../../img/krux-installer/locale_menu.png" alt="Krux-Installer locale menu" />
+<img width="640" src=" /krux/img/krux-installer/locale_menu.png" alt="Krux-Installer locale menu" />


tadeubas · 2025-12-05T20:18:50Z

Some nits about src=" /krux/img attribute on html stuffs. This creates unecessary diff and is out of the scope of the PR

Images need to have absolute path, otherwise Spanish will fail to get images on pages that doesn't have Spanish translation yet

qlrd · 2025-12-08T14:01:00Z

I would squash some commits that are *.md ones into docs commit and squash those that changed i18n/*.py into i18n, commits just to clear the revision diff.

This PR is hard to review and rebase to test it locally (due to selfcustody:develop <- westoleaboat:develop). A tip: when creating a new feature, create a branch like docs/spanish and do a PR that wants to merge selfcustody/develop <- westoleboat/docs/spanish.

This is one of reasons that I think we should encourage to read a CONTRIBUTING.md file as well conventional commits as stated in #787. It's a awesome work, but IMHO it deserve some "clean git history".

tadeubas · 2025-12-08T20:26:30Z

I would squash some commits

Please open a follow-up PR to westoleaboat. I think these requirements are a bit too strict for people submitting their first PRs

qlrd · 2026-01-05T20:43:38Z

Needs a rebase

docs: rebase conflicts

…esource in spanish

Can't see the request

odudex · 2026-03-20T14:44:36Z

I just checked out to this branch, fixed conflicts, however I don't see any image of the device in Spanish, even though this PR uploads hundreds of them.

tadeubas · 2026-03-20T18:01:25Z

I just checked out to this branch, fixed conflicts, however I don't see any image of the device in Spanish, even though this PR uploads hundreds of them.

Yeah, that’s definitely an issue. The image paths aren’t updated automatically, @westoleaboat need to change the URLs from /krux/img to /krux/es/img in the new .es.md files.

qlrd previously requested changes Dec 5, 2025

View reviewed changes

westoleaboat and others added 13 commits January 20, 2026 23:18

ADD es translation to docs pages

93ce9ee

fix menu for translations

2613ac1

moved templates img to correct folder

03c9bd6

dark and light modes

3898184

top menu titles and subentries translated to es

4b29d05

Fix mnemonic printing issue with long words

af8f2af

Added es imgs and fix sequences

51a1c96

(ADD) windows installing doc in spanish

510fa9d

fix typo

ce1ea09

Added missing imgs and other small fixes

4d94d57

(ADD) esp snippets

8d1a17a

(ADD) esp lang snippets

cd0a641

(ADD) esp docs

024b87d

westoleaboat force-pushed the develop branch from a08ea46 to 7254557 Compare January 21, 2026 02:26

tadeubas and others added 6 commits January 20, 2026 23:27

Updated image references to use absolute paths instead of relative links

13dc281

(ADD) espanish docs installing-from-gui linux mac windows other

2eeba0f

(FIX) improved choosing of words for better understanding in spanish

b9d416a

(ADD) installing from- esp docs

0e0bdd2

installing from source and usage index pages in spanish

7758867

(ADD) loading/generating a mnemonic docs into spanish

7254557

tadeubas and others added 3 commits January 21, 2026 12:10

docs: rebase conflicts

da1235f

Merge pull request #7 from tadeubas/esp-rebase-merge-conflicts

74afb5d

docs: rebase conflicts

(FIX) typos and improvements to translations; (ADD) verify-download r…

de28303

…esource in spanish

westoleaboat added 2 commits March 21, 2026 12:13

fix translations; added /es/img link

2c8e7e0

FIX translations and translated img links

e8bfb0e

		<img src="/krux/img/maixpy_m5stickv/load-mnemonic-kef-via-qr-250.png" align="right" class="m5stickv">
		<img src="/krux/img/maixpy_amigo/load-mnemonic-kef-via-qr-300.png" align="right" class="amigo">


		<img src="../../../img/mnemonic_xor.png" align="center">
		<img src="/krux/img/mnemonic_xor.png" align="center">

		@@ -0,0 +1,23 @@
		<img src="/krux/img/krux-devices.jpg" style="width: 40%; min-width: 260px;" class="align-right">

		@@ -0,0 +1,15 @@
		Puedes instalar Krux (ambos la versión oficial o beta) en tu dispotivo con chip K210 utilizando nuestra aplicación oficial para computador, Krux-Installer:

		[<img src="/krux/img/badge_github.png" width="186">](https://github.com/selfcustody/krux-installer/releases)

Conversation

westoleaboat commented Oct 24, 2025

What is this PR for?

Changes made to:

Did you build the code and tested on device?

What is the purpose of this pull request?

Uh oh!

tadeubas commented Nov 8, 2025

Uh oh!

westoleaboat commented Nov 11, 2025

Uh oh!

tadeubas commented Nov 12, 2025

Uh oh!

codecov bot commented Nov 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

odudex commented Nov 24, 2025

Uh oh!

qlrd left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tadeubas commented Dec 5, 2025

Uh oh!

qlrd commented Dec 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tadeubas commented Dec 8, 2025

Uh oh!

qlrd commented Jan 5, 2026

Uh oh!

odudex commented Mar 20, 2026

Uh oh!

tadeubas commented Mar 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov bot commented Nov 22, 2025 •

edited

Loading

qlrd commented Dec 8, 2025 •

edited

Loading