docs: serve templates page at folder URL via index.md
What changed, and why it matters
This commit is a documentation reorganization. It renames a templates page so it appears at a cleaner web address and updates internal links accordingly. There is no change to the Krux software, device firmware, or any security-sensitive code.
No security action needed; this is a routine documentation refactor.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The patch renames docs/getting-started/templates/templates.en.md to index.en.md, updates relative image paths from ../QR/… to QR/… (because the page is now one directory level shallower in the served URL), and updates two internal markdown links from templates.md to index.md. The mkdocs.yml navigation is adjusted to place the page under a ‘Templates’ section. No executable code, cryptographic logic, build scripts, or configuration handling is modified.
Changed components
Documentation site navigation and links (MkDocs)Inspect captured patch +141 / −138
diff --git a/docs/getting-started/features/QR-transcript-tools.en.md b/docs/getting-started/features/QR-transcript-tools.en.md
index d039a55..68676a5 100644
--- a/docs/getting-started/features/QR-transcript-tools.en.md
+++ b/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. Swipe left :material-gesture-swipe-left: or right :material-gesture-swipe-right: to change modes, or if your device doesn't have a touchscreen, press the `PAGE` buttons. See our [available transcribe templates](../templates/templates.md).
+When you export a mnemonic, encrypted mnemonic or a generic text QR code, alternative visualization modes will be available. Swipe left :material-gesture-swipe-left: or right :material-gesture-swipe-right: to change modes, or if your device doesn't have a touchscreen, press the `PAGE` buttons. See our [available transcribe templates](../templates/index.md).
### Standard Mode
<img src="../../../img/maixpy_m5stickv/standard-qr-code-250.png" align="right" class="m5stickv">
diff --git a/docs/getting-started/templates/index.en.md b/docs/getting-started/templates/index.en.md
new file mode 100644
index 0000000..01438c9
--- /dev/null
+++ b/docs/getting-started/templates/index.en.md
@@ -0,0 +1,137 @@
+# Templates
+
+Here we offer a few templates to [transcribe QR codes](../features/QR-transcript-tools.md), [Tinyseed or Binary Grid](../features/tinyseed.en.md) backups.
+
+## QR Code Templates
+You can manually copy compact SeedQR codes or place a proper sized template over the device screen.
+Protect the template backside with a transparent tape so you won't bleed ink through the paper to your device's screen.
+Then, using a marker, paint the QR code.
+
+### V1 - 21x21
+
+<a href="QR/png/qr_v1_dots_regions.png">
+ <img src="QR/png/qr_v1_dots_regions.png" alt="Dots" style="width: 20%; float: left; margin-left: 10px;">
+</a>
+
+<a href="QR/png/qr_v1_lines_regions.png">
+ <img src="QR/png/qr_v1_lines_regions.png" alt="Lines" style="width: 20%; float: left; margin-left: 10px;">
+</a>
+
+<a href="QR/png/qr_v1_dots_lines_regions.png">
+ <img src="QR/png/qr_v1_dots_lines_regions.png" alt="Dots Lines" style="width: 20%; float: left; margin-left: 10px;">
+</a>
+
+<div style="clear: both"></div>
+SVG: [Dots](QR/svg/qr_v1_dots_regions.svg), [Lines](QR/svg/qr_v1_lines_regions.svg), [Dots and Lines](QR/svg/qr_v1_dots_lines_regions.svg)
+
+### V2 - 25x25
+
+<a href="QR/png/qr_v2_dots_regions.png">
+ <img src="QR/png/qr_v2_dots_regions.png" alt="Dots" style="width: 20%; float: left; margin-left: 10px;">
+</a>
+
+<a href="QR/png/qr_v2_lines_regions.png">
+ <img src="QR/png/qr_v2_lines_regions.png" alt="Lines" style="width: 20%; float: left; margin-left: 10px;">
+</a>
+
+<a href="QR/png/qr_v2_dots_lines_regions.png">
+ <img src="QR/png/qr_v2_dots_lines_regions.png" alt="Dots Lines" style="width: 20%; float: left; margin-left: 10px;">
+</a>
+
+<div style="clear: both"></div>
+SVG: [Dots](QR/svg/qr_v2_dots_regions.svg), [Lines](QR/svg/qr_v2_lines_regions.svg), [Dots and Lines](QR/svg/qr_v2_dots_lines_regions.svg)
+
+### V3 - 29x29
+
+<a href="QR/png/qr_v3_dots_regions.png">
+ <img src="QR/png/qr_v3_dots_regions.png" alt="Dots" style="width: 20%; float: left; margin-left: 10px;">
+</a>
+
+<a href="QR/png/qr_v3_lines_regions.png">
+ <img src="QR/png/qr_v3_lines_regions.png" alt="Lines" style="width: 20%; float: left; margin-left: 10px;">
+</a>
+
+<a href="QR/png/qr_v3_dots_lines_regions.png">
+ <img src="QR/png/qr_v3_dots_lines_regions.png" alt="Dots Lines" style="width: 20%; float: left; margin-left: 10px;">
+</a>
+
+<div style="clear: both"></div>
+SVG: [Dots](QR/svg/qr_v3_dots_regions.svg), [Lines](QR/svg/qr_v3_lines_regions.svg), [Dots and Lines](QR/svg/qr_v3_dots_lines_regions.svg)
+
+### V4 - 33x33
+
+<a href="QR/png/qr_v4_dots_regions.png">
+ <img src="QR/png/qr_v4_dots_regions.png" alt="Dots" style="width: 20%; float: left; margin-left: 10px;">
+</a>
+
+<a href="QR/png/qr_v4_lines_regions.png">
+ <img src="QR/png/qr_v4_lines_regions.png" alt="Lines" style="width: 20%; float: left; margin-left: 10px;">
+</a>
+
+<a href="QR/png/qr_v4_dots_lines_regions.png">
+ <img src="QR/png/qr_v4_dots_lines_regions.png" alt="Dots Lines" style="width: 20%; float: left; margin-left: 10px;">
+</a>
+
+<div style="clear: both"></div>
+SVG: [Dots](QR/svg/qr_v4_dots_regions.svg), [Lines](QR/svg/qr_v4_lines_regions.svg), [Dots and Lines](QR/svg/qr_v4_dots_lines_regions.svg)
+
+### V5 - 37x37
+
+<a href="QR/png/qr_v5_dots_regions.png">
+ <img src="QR/png/qr_v5_dots_regions.png" alt="Dots" style="width: 20%; float: left; margin-left: 10px;">
+</a>
+
+<a href="QR/png/qr_v5_lines_regions.png">
+ <img src="QR/png/qr_v5_lines_regions.png" alt="Lines" style="width: 20%; float: left; margin-left: 10px;">
+</a>
+
+<a href="QR/png/qr_v5_dots_lines_regions.png">
+ <img src="QR/png/qr_v5_dots_lines_regions.png" alt="Dots Lines" style="width: 20%; float: left; margin-left: 10px;">
+</a>
+
+<div style="clear: both"></div>
+SVG: [Dots](QR/svg/qr_v5_dots_regions.svg), [Lines](QR/svg/qr_v5_lines_regions.svg), [Dots and Lines](QR/svg/qr_v5_dots_lines_regions.svg)
+
+## Tinyseed Templates
+
+[Tinyseed](../features/tinyseed.en.md) background of blank templates to be manually filled.
+
+<div style="clear: both"></div>
+
+<a href="tiny_seed_scan_background.png">
+ <img src="tiny_seed_scan_background.png" alt="Tinyseed Scan Background" style="width: 15%; float: left; margin-left: 10px;">
+</a>
+
+<a href="tiny_seed_template.png">
+ <img src="tiny_seed_template.png" alt="Tinyseed Scan Background" style="width: 15%; float: left; margin-left: 10px;">
+</a>
+
+<a href="tiny_seed_template_24w.png">
+ <img src="tiny_seed_template_24w.png" alt="Tinyseed Scan Background" style="width: 22%; float: left; margin-left: 10px;">
+</a>
+
+
+<div style="clear: both"></div>
+
+## Binary Grid Templates
+
+[Binary Grid](../features/tinyseed.en.md) labeled and and "stealth" clean templates.
+
+<div style="clear: both"></div>
+
+<a href="Krux_Binary_Grid_double_rev1.png">
+ <img src="Krux_Binary_Grid_double_rev1.png" alt="Tinyseed Scan Background" style="width: 30%; float: left; margin-left: 10px;">
+</a>
+
+<a href="Krux_Binary_Grid_double_clean_rev1.png">
+ <img src="Krux_Binary_Grid_double_clean_rev1.png" alt="Tinyseed Scan Background" style="width: 30%; float: left; margin-left: 10px;">
+</a>
+
+<div style="clear: both"></div>
+
+[Binary Grid svg source](Krux_Binary_Grid_double_rev1.svg)
+
+[Binary Grid Clean svg source](Krux_Binary_Grid_double_clean_rev1.svg)
+
+## Edit Templates
+To edit the source file (.svg) it is recommended to use Inkscape and set it to use mm unit. "Unscaled models" from QR code templates have the 21x21 or 25x25mm size for 12 or 24 respectively, this way making them easier to edit.
diff --git a/docs/getting-started/templates/templates.en.md b/docs/getting-started/templates/templates.en.md
deleted file mode 100644
index 3dfddb2..0000000
--- a/docs/getting-started/templates/templates.en.md
+++ /dev/null
@@ -1,135 +0,0 @@
-Here we offer a few templates to [transcribe QR codes](../features/QR-transcript-tools.md), [Tinyseed or Binary Grid](../features/tinyseed.en.md) backups.
-
-## QR Code Templates
-You can manually copy compact SeedQR codes or place a proper sized template over the device screen.
-Protect the template backside with a transparent tape so you won't bleed ink through the paper to your device's screen.
-Then, using a marker, paint the QR code.
-
-### V1 - 21x21
-
-<a href="../QR/png/qr_v1_dots_regions.png">
- <img src="../QR/png/qr_v1_dots_regions.png" alt="Dots" style="width: 20%; float: left; margin-left: 10px;">
-</a>
-
-<a href="../QR/png/qr_v1_lines_regions.png">
- <img src="../QR/png/qr_v1_lines_regions.png" alt="Lines" style="width: 20%; float: left; margin-left: 10px;">
-</a>
-
-<a href="../QR/png/qr_v1_dots_lines_regions.png">
- <img src="../QR/png/qr_v1_dots_lines_regions.png" alt="Dots Lines" style="width: 20%; float: left; margin-left: 10px;">
-</a>
-
-<div style="clear: both"></div>
-SVG: [Dots](../QR/svg/qr_v1_dots_regions.svg), [Lines](../QR/svg/qr_v1_lines_regions.svg), [Dots and Lines](../QR/svg/qr_v1_dots_lines_regions.svg)
-
-### V2 - 25x25
-
-<a href="../QR/png/qr_v2_dots_regions.png">
- <img src="../QR/png/qr_v2_dots_regions.png" alt="Dots" style="width: 20%; float: left; margin-left: 10px;">
-</a>
-
-<a href="../QR/png/qr_v2_lines_regions.png">
- <img src="../QR/png/qr_v2_lines_regions.png" alt="Lines" style="width: 20%; float: left; margin-left: 10px;">
-</a>
-
-<a href="../QR/png/qr_v2_dots_lines_regions.png">
- <img src="../QR/png/qr_v2_dots_lines_regions.png" alt="Dots Lines" style="width: 20%; float: left; margin-left: 10px;">
-</a>
-
-<div style="clear: both"></div>
-SVG: [Dots](../QR/svg/qr_v2_dots_regions.svg), [Lines](../QR/svg/qr_v2_lines_regions.svg), [Dots and Lines](../QR/svg/qr_v2_dots_lines_regions.svg)
-
-### V3 - 29x29
-
-<a href="../QR/png/qr_v3_dots_regions.png">
- <img src="../QR/png/qr_v3_dots_regions.png" alt="Dots" style="width: 20%; float: left; margin-left: 10px;">
-</a>
-
-<a href="../QR/png/qr_v3_lines_regions.png">
- <img src="../QR/png/qr_v3_lines_regions.png" alt="Lines" style="width: 20%; float: left; margin-left: 10px;">
-</a>
-
-<a href="../QR/png/qr_v3_dots_lines_regions.png">
- <img src="../QR/png/qr_v3_dots_lines_regions.png" alt="Dots Lines" style="width: 20%; float: left; margin-left: 10px;">
-</a>
-
-<div style="clear: both"></div>
-SVG: [Dots](../QR/svg/qr_v3_dots_regions.svg), [Lines](../QR/svg/qr_v3_lines_regions.svg), [Dots and Lines](../QR/svg/qr_v3_dots_lines_regions.svg)
-
-### V4 - 33x33
-
-<a href="../QR/png/qr_v4_dots_regions.png">
- <img src="../QR/png/qr_v4_dots_regions.png" alt="Dots" style="width: 20%; float: left; margin-left: 10px;">
-</a>
-
-<a href="../QR/png/qr_v4_lines_regions.png">
- <img src="../QR/png/qr_v4_lines_regions.png" alt="Lines" style="width: 20%; float: left; margin-left: 10px;">
-</a>
-
-<a href="../QR/png/qr_v4_dots_lines_regions.png">
- <img src="../QR/png/qr_v4_dots_lines_regions.png" alt="Dots Lines" style="width: 20%; float: left; margin-left: 10px;">
-</a>
-
-<div style="clear: both"></div>
-SVG: [Dots](../QR/svg/qr_v4_dots_regions.svg), [Lines](../QR/svg/qr_v4_lines_regions.svg), [Dots and Lines](../QR/svg/qr_v4_dots_lines_regions.svg)
-
-### V5 - 37x37
-
-<a href="../QR/png/qr_v5_dots_regions.png">
- <img src="../QR/png/qr_v5_dots_regions.png" alt="Dots" style="width: 20%; float: left; margin-left: 10px;">
-</a>
-
-<a href="../QR/png/qr_v5_lines_regions.png">
- <img src="../QR/png/qr_v5_lines_regions.png" alt="Lines" style="width: 20%; float: left; margin-left: 10px;">
-</a>
-
-<a href="../QR/png/qr_v5_dots_lines_regions.png">
- <img src="../QR/png/qr_v5_dots_lines_regions.png" alt="Dots Lines" style="width: 20%; float: left; margin-left: 10px;">
-</a>
-
-<div style="clear: both"></div>
-SVG: [Dots](../QR/svg/qr_v5_dots_regions.svg), [Lines](../QR/svg/qr_v5_lines_regions.svg), [Dots and Lines](../QR/svg/qr_v5_dots_lines_regions.svg)
-
-## Tinyseed Templates
-
-[Tinyseed](../features/tinyseed.en.md) background of blank templates to be manually filled.
-
-<div style="clear: both"></div>
-
-<a href="../tiny_seed_scan_background.png">
- <img src="../tiny_seed_scan_background.png" alt="Tinyseed Scan Background" style="width: 15%; float: left; margin-left: 10px;">
-</a>
-
-<a href="../tiny_seed_template.png">
- <img src="../tiny_seed_template.png" alt="Tinyseed Scan Background" style="width: 15%; float: left; margin-left: 10px;">
-</a>
-
-<a href="../tiny_seed_template_24w.png">
- <img src="../tiny_seed_template_24w.png" alt="Tinyseed Scan Background" style="width: 22%; float: left; margin-left: 10px;">
-</a>
-
-
-<div style="clear: both"></div>
-
-## Binary Grid Templates
-
-[Binary Grid](../features/tinyseed.en.md) labeled and and "stealth" clean templates.
-
-<div style="clear: both"></div>
-
-<a href="../Krux_Binary_Grid_double_rev1.png">
- <img src="../Krux_Binary_Grid_double_rev1.png" alt="Tinyseed Scan Background" style="width: 30%; float: left; margin-left: 10px;">
-</a>
-
-<a href="../Krux_Binary_Grid_double_clean_rev1.png">
- <img src="../Krux_Binary_Grid_double_clean_rev1.png" alt="Tinyseed Scan Background" style="width: 30%; float: left; margin-left: 10px;">
-</a>
-
-<div style="clear: both"></div>
-
-[Binary Grid svg source](Krux_Binary_Grid_double_rev1.svg)
-
-[Binary Grid Clean svg source](Krux_Binary_Grid_double_clean_rev1.svg)
-
-## Edit Templates
-To edit the source file (.svg) it is recommended to use Inkscape and set it to use mm unit. "Unscaled models" from QR code templates have the 21x21 or 25x25mm size for 12 or 24 respectively, this way making them easier to edit.
diff --git a/docs/getting-started/usage/loading-a-mnemonic.en.md b/docs/getting-started/usage/loading-a-mnemonic.en.md
index cef1e0a..be1f24f 100644
--- a/docs/getting-started/usage/loading-a-mnemonic.en.md
+++ b/docs/getting-started/usage/loading-a-mnemonic.en.md
@@ -31,7 +31,7 @@ You can also use [an offline QR code generator for this](https://iancoleman.io/b
#### Tinyseed, OneKey KeyTag or Binary Grid
[Tinyseed](https://tinyseed.io/), [Onekey KeyTag](https://onekey.so/products/onekey-keytag/) and others directly encode a seed as binary, allowing for a very compact mnemonic storage. Krux devices have machine vision capabilities that allow users to scan these metal plates and instantly load mnemonics engraved on them (this feature is not available in [Krux Mobile Android app](../../faq.md#what-is-krux-mobile-android-app)).
-To ensure a proper scan, place the backup plate over a black background and fill in the punched areas with black to enhance contrast. Alternatively, you can scan a [thermally printed version](../features/printing/printing.md) or a completed template. You can view some [examples of encoded mnemonics here](../features/tinyseed.md), and explore our [available transcription templates here](../templates/templates.md).
+To ensure a proper scan, place the backup plate over a black background and fill in the punched areas with black to enhance contrast. Alternatively, you can scan a [thermally printed version](../features/printing/printing.md) or a completed template. You can view some [examples of encoded mnemonics here](../features/tinyseed.md), and explore our [available transcription templates here](../templates/index.md).
### Via Manual Input
<img src="../../../img/maixpy_m5stickv/load-mnemonic-manual-options-250.png" align="right" class="m5stickv">
diff --git a/mkdocs.yml b/mkdocs.yml
index dfdae6b..2633d4f 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -117,7 +117,8 @@ nav:
- Mnemonic XOR: getting-started/features/mnemonic-xor.en.md
- Interface:
- Settings: getting-started/settings.en.md
- - Templates: getting-started/templates/templates.en.md
+ - Templates:
+ - getting-started/templates/index.en.md
- Video Tutorials: video-tutorials.en.md
- Devices and Parts List: parts.en.md
- FAQ: faq.en.md
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.