Merge pull request #338 from tadeubas/docs-update

docs adding info about templates

docs/faq.en.md

@@ -26,7 +26,9 @@ Your device should charge and turn on when connected to a USB-A port, even if it
 If your device is not charging or being recognized as expected, try using a different USB port or a different computer to determine if the issue is with the device or the host's USB port.
 
 ## Why isn't my M5stickV device being recognized and charged when connected to the computer's USB-C?
-M5stickV's USB-C port lacks pull up resistors required for it to be recognized and powered by host(computer) USB-C ports. If you don't have an USB-A available, you can use a USB hub connected between your computer's USB-C and M5stickV
+----8<----
+m5stickv-usb-c.md
+----8<----
 
 ## Why does my Krux device randomly freeze or restart when connected to the computer?
 Windows is known to have issues with the USB-C devices. If you are experiencing random crashes or even reboots and your device does not have a battery, try using a phone charger or other power source such as a power bank.

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

@@ -1,4 +1,4 @@
-When you export a mnemonic, encrypted mnemonic or a generic text QR code, alternative visualization modes will be available. To change modes swipe sideways, or press `Page` buttons if the device doesn't have touchscreen.
+When you export a mnemonic, encrypted mnemonic or a generic text QR code, alternative visualization modes will be available. To change modes swipe sideways, or press `Page` buttons if the device doesn't have touchscreen. Find transcribe templates [here](https://github.com/odudex/krux_binaries/tree/main/templates).
 
 ### Standard Mode
 <img src="../../../img/maixpy_m5stickv/standard-qr-code-125.png" align="right">

docs/getting-started/features/sd-card-update.en.md

@@ -1,7 +1,7 @@
 ### Upgrade via microSD card
 Once you've installed the initial firmware on your device via USB, you can either continue updating the device by flashing via USB or you can perform upgrades via microSD card to keep the device airgapped.
 
-To perform an upgrade, simply copy the [official release](https://github.com/selfcustody/krux/releases) `firmware.bin` and `firmware.bin.sig` files to the root of a FAT-32(MBR) formatted microSD card, insert the card into your device, and reboot the device. If it detects the new firmware file and is able to verify the signature, you will be prompted to install it.
+To perform an upgrade, simply copy the [official release](https://github.com/selfcustody/krux/releases) `firmware.bin` and `firmware.bin.sig` files to the root of a FAT-32 (MBR) formatted microSD card, insert the card into your device, and reboot the device. If it detects the new firmware file and is able to verify the signature, you will be prompted to install it.
 
 Once installation is complete, eject the microSD card and delete the firmware files before reinserting and rebooting. Otherwise you will be prompted to install it again.
 

docs/getting-started/usage/loading-a-mnemonic.en.md

@@ -28,7 +28,7 @@ You can also use [an offline QR code generator for this](https://iancoleman.io/b
 #### Tiny Seed
 
 [Tiny Seed](https://tinyseed.io/) is a compact metal plate mnemonic backup method.
-Krux devices have machine vision capabilities that allow users to scan these metal plates and instantly load mnemonics engraved on them. To properly scan them place the Tiny Seed over a black background and paint the punched bits black to increase contrast.
+Krux devices have machine vision capabilities that allow users to scan these metal plates and instantly load mnemonics engraved on them. To properly scan them place the Tiny Seed over a black background and paint the punched bits black to increase contrast. You can also scan the thermally printed version, or a filled template. Find templates to scan or print [here](https://github.com/odudex/krux_binaries/tree/main/templates).
 
 ### Via Manual Input
 <img src="../../../img/maixpy_m5stickv/load-mnemonic-manual-options-125.png" align="right">
@@ -44,7 +44,9 @@ Manually type `Words`, `Word Numbers`, `Tiny Seed` (toggle the bits or punches)
 
 Enter each word of your BIP-39 mnemonic one at a time. Krux will disable impossible-to-reach letters as you type and will attempt to autocomplete your words to speed up the process.
 
-On your 12th or 24th word, you can leave the word blank to have Krux generate the final word of your mnemonic for you. This is handy if you chose a manual method to generate your mnemonic and want the final word to be a valid checksum.
+----8<----
+12th-24th-word-generate.md
+----8<----
 
 <div style="clear: both"></div>
 
@@ -53,29 +55,31 @@ On your 12th or 24th word, you can leave the word blank to have Krux generate th
 <img src="../../../img/maixpy_amigo/load-mnemonic-via-numbers-word-150.png" align="right">
 
 ##### Decimal
-
 Enter each word of your BIP-39 mnemonic as a number from 1 to 2048 one at a time. You can use [this list](https://github.com/bitcoin/bips/blob/master/bip-0039/english.txt) for reference.
-##### Hexadecimal and Octal
 
-You can also enter your mnemonic as hexadecimal numbers, with values ranging from 0x1 to 0x800 or octal numbers, with values ranging from 01 to 04000. This is useful with some metal plate backups that store mnemonic word numbers using these formats.
+##### Hexadecimal and Octal
+You can also enter your BIP-39 mnemonic word's numbers (1-2048) in hexadecimal format, with values ranging from 0x1 to 0x800, or in octal format, with values ranging from 01 to 04000. This is useful with some metal plate backups that uses those formats.
 
-On your 12th or 24th word, you can leave the word blank to have Krux generate the final word of your mnemonic for you. This is handy if you chose a manual method to generate your mnemonic and want the final word to be a valid checksum.
+##### Final checksum word
+----8<----
+12th-24th-word-generate.md
+----8<----
 
 <div style="clear: both"></div>
 
 #### Tiny Seed (Bits)
 <img src="../../../img/maixpy_m5stickv/load-mnemonic-via-tinyseed-filled-125.png" align="right">
 <img src="../../../img/maixpy_amigo/load-mnemonic-via-tinyseed-filled-150.png" align="right">
 
-Enter each word of your BIP-39 mnemonic words in their binary form, toggling necessary bits to recreate each of the word's respective number. Last word will have checksum bits dynamically toggled while you fill previous bits.
+Enter the BIP-39 mnemonic word's numbers (1-2048) in binary format, toggling necessary bits to recreate each of the word's respective number. The last word will have checksum bits dynamically toggled while you fill the bits.
 
 <div style="clear: both"></div>
 
 #### Stackbit 1248
 <img src="../../../img/maixpy_m5stickv/load-mnemonic-via-stackbit-filled-125.png" align="right">
 <img src="../../../img/maixpy_amigo/load-mnemonic-via-stackbit-filled-150.png" align="right">
 
-Enter mnemonic BIP-39 word's numbers using Stackbit 1248 metal plate backup method, where each of the four digits of the word's number is a sum of marked (punched) numbers 1,2,4 and 8. For example, to enter the word "pear", number 1297, you have to punch (1)(2)(1+8=9)(1+2+4=7)
+Enter the BIP-39 mnemonic word's numbers (1-2048) using the Stackbit 1248 metal plate backup method, where each of the four digits of the word's number is a sum of the numbers marked (punched) 1, 2, 4, or 8. For example, to enter the word "pear", number 1297, you must punch (1)(2)(1+8=9)(1+2+4=7).
 
 <div style="clear: both"></div>
 
@@ -109,15 +113,15 @@ After confirming the mnemonic words, you can optionally choose to type or scan a
 <img src="../../../img/maixpy_m5stickv/load-mnemonic-seq-fingerprint-125.png" align="right">
 <img src="../../../img/maixpy_amigo/load-mnemonic-seq-fingerprint-150.png" align="right">
 
-The wallet's fingerprint, if you have it noted down, will help you make sure you entered the correct mnemonic and passphrase(optional) and will load the expected wallet.
+The wallet's fingerprint, if you have it noted down, will help you make sure you entered the correct mnemonic and passphrase (optional) and will load the expected wallet.
 
 <div style="clear: both"></div>
 
 ### Single-sig or Multisig
 <img src="../../../img/maixpy_m5stickv/load-mnemonic-seq-single-multi-125.png" align="right">
 <img src="../../../img/maixpy_amigo/load-mnemonic-seq-single-multi-150.png" align="right">
 
-After loading your mnemonic and passphrase(optional), you will be asked if you want to use it as part of a `Single-sig` or `Multisig` wallet.
+After loading your mnemonic and passphrase (optional), you will be asked if you want to use it as part of a `Single-sig` or `Multisig` wallet.
 
 Your choice here will subtly change the generated xpub that is used to set up your device in your wallet coordinator software. You can learn more about the difference in the following guides for using [single-sig](using-a-single-sig-wallet.md) and [multisig](using-a-multisig-wallet.md) wallets.
 

docs/getting-started/usage/navigating-the-main-menu.en.md

@@ -9,7 +9,7 @@ After entering your mnemonic, and loading a wallet, you will find yourself on Kr
 <img src="../../../img/maixpy_m5stickv/backup-options-125.png" align="right">
 <img src="../../../img/maixpy_amigo/backup-options-150.png" align="right">
 
-This will open a new submenu with the following options to backup your mnemonic.
+This will open a new submenu with the following options to backup your mnemonic. If you set a [printer driver](../../settings/#driver), it will also give the option to print the backup!
 
 <div style="clear: both"></div>
 
@@ -58,15 +58,15 @@ Words are converted to their BIP-39 numeric indexes, those numbers are then conc
 <img src="../../../img/maixpy_m5stickv/backup-stackbit-125.png" align="right">
 <img src="../../../img/maixpy_amigo/backup-stackbit-150.png" align="right">
 
-Words are converted to their BIP-39 numeric indexes, then each of the four digits is converted to a sum of 1,2,4 or 8.
+This metal backup format represents the BIP-39 mnemonic word's numbers (1-2048). Each of the four digits is converted to a sum of 1, 2, 4 or 8. This option does not print even if a printer driver is set.
 
 <div style="clear: both"></div>
 
 #### Tiny Seed
 <img src="../../../img/maixpy_m5stickv/backup-tiny-seed-125.png" align="right">
 <img src="../../../img/maixpy_amigo/backup-tiny-seed-150.png" align="right">
 
-This metal backup format represent BIP-39 mnemonic word numbers index on its binary form on a metal plate, where 1's are marked(punched) and 0's are left intact
+This metal backup format represents the BIP-39 mnemonic word's numbers (1-2048) in binary format on a metal plate, where the 1's are marked (punched) and the 0's are left intact.
 
 <div style="clear: both"></div>
 
@@ -217,4 +217,4 @@ This feature is used to sign Krux releases, airgapped, using a Krux device.
 <img src="../../../img/maixpy_m5stickv/sign-message-at-address-prompt-125.png" align="right">
 <img src="../../../img/maixpy_amigo/sign-message-at-address-prompt-150.png" align="right">
 
-Coordinators like Sparrow and Specter offer the possibility to sign messages at a Bitcoin receive address, allowing you to attest ownership of that address. Krux will detect if the message is of this type and present a similar workflow for signing. The main difference is that the address will be displayed along with the raw message, and since the message is signed with a derived address instead of the master public key, Krux won't offer the option to export the raw public key after the signature.
+Coordinators like Sparrow and Specter offer the possibility to sign messages at a Bitcoin receive address, allowing you to attest ownership of that address. Krux will detect if the message is of this type and present a similar workflow for signing. The main difference is that the address will be displayed along with the raw message, and since the message is signed with a derived address instead of the master public key, Krux won't offer the option to export the raw public key after the signature.

docs/parts.en.md

@@ -14,7 +14,9 @@
 | Warnings  | [:material-information:{ title="M5stickV and USB-C" }](#m5stickv-info) | [:material-information:{ title="Maix Amigo screens" }](#amigo-info) | [:material-information:{ title="Maix Dock and soldered pin" }](#dock-info) | Camera has<br> lens distortion | Micro USB |
 
 <i style="font-size: 85%">:material-information:{id="m5stickv-info"}:
-M5stickV's USB-C port lacks pull up resistors required for it to be recognized and powered by host(computer) USB-C ports. If you don't have an USB-A available, you can use a USB hub connected between your computer's USB-C and M5stick.
+----8<----
+m5stickv-usb-c.md
+----8<----
 </i>
 
 <i style="font-size: 85%">:material-information:{id="amigo-info"}:

docs/snippets/12th-24th-word-generate.md

@@ -0,0 +1 @@
+On your 12th or 24th word, you can leave it blank to have Krux generate the final checksum word of your mnemonic for you. This is useful when you choose a manual method to generate your mnemonic and want the final BIP-39 checksum word to be valid.

docs/snippets/m5stickv-usb-c.md

@@ -0,0 +1 @@
+M5stickV's USB-C port lacks pull up resistors required for it to be recognized and powered by host (computer) USB-C ports. If you don't have an USB-A available, you can use a USB hub connected between your computer's USB-C and M5stickV.