Skip to content

Conversation

@westoleaboat
Copy link

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
Copy link
Member

tadeubas commented Nov 8, 2025

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
Copy link
Author

hi @tadeubas yes we should do it.

@tadeubas
Copy link
Member

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

@codecov
Copy link

codecov bot commented Nov 22, 2025

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
Copy link
Member

odudex commented Nov 24, 2025

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.

Copy link
Member

@qlrd qlrd left a comment

Choose a reason for hiding this comment

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

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.

### 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">
Copy link
Member

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

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

Comment on lines +12 to +21
<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">
Copy link
Member

Choose a reason for hiding this comment

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

Here too

Comment on lines +36 to +45
<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">
Copy link
Member

Choose a reason for hiding this comment

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

Here too

Comment on lines +8 to +9
<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">
Copy link
Member

Choose a reason for hiding this comment

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

Here too

Comment on lines 8 to +9

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

Choose a reason for hiding this comment

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

Here too

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

Choose a reason for hiding this comment

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

Here too

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)
Copy link
Member

Choose a reason for hiding this comment

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

Here too

@@ -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)
Copy link
Member

Choose a reason for hiding this comment

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

Here too

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" />
Copy link
Member

Choose a reason for hiding this comment

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

Here too

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" />
Copy link
Member

Choose a reason for hiding this comment

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

Here too

@tadeubas
Copy link
Member

tadeubas commented Dec 5, 2025

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
Copy link
Member

qlrd commented Dec 8, 2025

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
Copy link
Member

tadeubas commented Dec 8, 2025

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
Copy link
Member

qlrd commented Jan 5, 2026

Needs a rebase

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.

4 participants