What changed, and why it matters
This commit only fixes broken or awkward documentation links inside the project's user guide. It replaces relative links that point outside the documentation folder with internal placeholder files or direct GitHub URLs. There is no change to any firmware, software, or cryptographic code, and no security impact.
No security action required; treat as routine documentation maintenance.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff is limited to Markdown files under docs/. It adds a few symlink-like placeholder files (e.g., docs/common/protocol_v1/protocol.md pointing to ../../../common/protob/protocol.md, docs/python/trezorlib.md pointing to ../../python/README.md, docs/misc/toiftool.md pointing to ../../python/tools/toiftool/README.md) and updates SUMMARY.md and several .md files to use those placeholders or absolute GitHub URLs. No source code, build scripts, protocol implementation, or crypto logic is modified.
Changed components
docs/SUMMARY.mddocs/common/protocol_v1/index.mddocs/common/protocol_v1/protocol.mddocs/common/thp/index.mddocs/common/thp/specification.mddocs/core/misc/translations.mddocs/misc/toif.mddocs/misc/toiftool.mddocs/python/index.mddocs/python/trezorlib.mdInspect captured patch +14 / −8
### docs/SUMMARY.md
@@ -32,9 +32,10 @@
- [Legacy](legacy/index.md)
- [Firmware format](legacy/firmware-format.md)
- [Python](python/index.md)
- - [trezorlib](../../python/README.md)
+ - [trezorlib](python/trezorlib.md)
- [Common](common/index.md)
- [Protocol V1](common/protocol_v1/index.md)
+ - [Protocol](common/protocol_v1/protocol.md)
- [Sessions](common/protocol_v1/sessions.md)
- [Passphrase](common/protocol_v1/passphrase.md)
- [Migration](common/protocol_v1/passphrase-redesign-migration.md)
@@ -62,6 +63,7 @@
- [Monorepo Notes](misc/monorepo.md)
- [Review Process](misc/review.md)
- [TOIF Image Format](misc/toif.md)
+ - [toiftool](misc/toiftool.md)
- [Developers guide](developers/index.md)
- [Libraries](developers/libraries.md)
- [Hello World in Trezor Core](developers/hello_world_in_core.md)
### docs/common/protocol_v1/index.md
@@ -5,5 +5,6 @@ _Note: In this section we describe the internal functioning of the old communica
## Notable topics
+- [Protocol](protocol.md)
- [Sessions](sessions.md)
- [Passphrase](passphrase.md)
### docs/common/protocol_v1/protocol.md
@@ -0,0 +1 @@
+../../../common/protob/protocol.md
\ No newline at end of file
### docs/common/thp/index.md
@@ -1,6 +1,6 @@
# Trezor–Host Protocol
-This section specifies a secure protocol for encrypted and authenticated communication between a host application, such as *Trezor Suite*, and new *Trezor* models (since 2025). This protocol replaces the unencrypted Codec v1 protocol used in earlier Trezor models (see [protocol.md](../../../common/protob/protocol.md)).
+This section specifies a secure protocol for encrypted and authenticated communication between a host application, such as *Trezor Suite*, and new *Trezor* models (since 2025). This protocol replaces the unencrypted Codec v1 protocol used in earlier Trezor models (see [protocol.md](../protocol_v1/protocol.md)).
## Notable topics
### docs/common/thp/specification.md
@@ -1,6 +1,6 @@
# Trezor–Host Protocol
-This document specifies a secure protocol for encrypted and authenticated communication between a host application, such as *Trezor Suite*, and new *Trezor* models. This protocol replaces the unencrypted Codec v1 protocol used in earlier Trezor models (see [protocol.md](../../../common/protob/protocol.md)).
+This document specifies a secure protocol for encrypted and authenticated communication between a host application, such as *Trezor Suite*, and new *Trezor* models. This protocol replaces the unencrypted Codec v1 protocol used in earlier Trezor models (see [protocol.md](../protocol_v1/protocol.md)).
# Intended audience
### docs/core/misc/translations.md
@@ -2,11 +2,11 @@
## Overview
-`Trezor` stores translated strings in `.json` files in [core/translations directory](../../../core/translations) - e.g. [de.json](../../../core/translations/de.json).
+`Trezor` stores translated strings in `.json` files in [core/translations directory](https://github.com/trezor/trezor-firmware/tree/main/core/translations) - e.g. [de.json](https://github.com/trezor/trezor-firmware/blob/main/core/translations/de.json).
-When no foreign-language is present, the English version is used - [en.json](../../../core/translations/en.json).
+When no foreign-language is present, the English version is used - [en.json](https://github.com/trezor/trezor-firmware/blob/main/core/translations/en.json).
-Translations files contain the translated strings and also all the special font characters as a link to `.json` files in [fonts](../../../core/translations/fonts) directory. Font files are not needed for `english`, which uses just default/built-in `ASCII` characters.
+Translations files contain the translated strings and also all the special font characters as a link to `.json` files in [fonts](https://github.com/trezor/trezor-firmware/tree/main/core/translations/fonts) directory. Font files are not needed for `english`, which uses just default/built-in `ASCII` characters.
## Generating blobs
### docs/misc/toif.md
@@ -68,5 +68,5 @@ zdata = z.compress(pixeldata) + z.flush()
Tool for converting PNGs into TOI format and back, see the following links for more:
-* [README](../../python/tools/toiftool/README.md)
+* [README](toiftool.md)
* [Code](https://github.com/trezor/trezor-firmware/blob/main/python/tools/toiftool/toiftool.py)
### docs/misc/toiftool.md
@@ -0,0 +1 @@
+../../python/tools/toiftool/README.md
\ No newline at end of file
### docs/python/index.md
@@ -2,4 +2,4 @@
To be documented by @matejcik, see [#229](https://github.com/trezor/trezor-firmware/issues/229).
-In the meantime see `python/docs` and [README](../../python/README.md) for the [PyPI package](https://pypi.org/project/trezor).
+In the meantime see `python/docs` and [README](trezorlib.md) for the [PyPI package](https://pypi.org/project/trezor).
### docs/python/trezorlib.md
@@ -0,0 +1 @@
+../../python/README.md
\ No newline at end of fileWhy 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.