Public commit record
80/100 · Strong
What the developer wrote
Authored by M1nd3r
chore(docs): fix and improve doc-links
- Fixed broken links to non-existent places.
- Replaced doc links to github by relative links to the md files. This allows to use `docs.trezor.io` without being needlessly transported to the github version of the linked doc page.
- Replaced "links to symlinks" by" links to the original files". Symlinks do not work nicely on github - user must manually find the symlinked doc page.
[no changelog]
✓ Descriptive subject✓ Names a concrete action or component✓ Uses a recognizable type or scope✓ Provides detailed explanatory context
What changed, and why it matters
This commit only updates documentation links inside the Trezor firmware repository. It fixes broken links, replaces GitHub URLs with relative links, and removes a symlinked documentation file. There are no code changes and no security impact.
Recommended action
No security action required. Treat as routine documentation maintenance.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The commit modifies eight Markdown files under docs/, adjusting internal and external hyperlinks. It deletes docs/python/trezorlib.md, which was a symlink to ../../python/README.md, and points references directly to that README. No source code, build scripts, firmware logic, or cryptographic operations are changed.
Changed components
docs/SUMMARY.mddocs/common/message-workflows.mddocs/developers/hello_world_in_core.mddocs/index.mddocs/legacy/firmware-format.mddocs/misc/toif.mddocs/python/index.mddocs/python/trezorlib.mdInspect captured patch +7 / −8
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
index 5890cb66..1ed864a8 100644
--- a/docs/SUMMARY.md
+++ b/docs/SUMMARY.md
@@ -29,7 +29,7 @@
- [Legacy](legacy/index.md)
- [Firmware format](legacy/firmware-format.md)
- [Python](python/index.md)
- - [trezorlib](python/trezorlib.md)
+ - [trezorlib](../../python/README.md)
- [Common](common/index.md)
- [Protocol V1](common/protocol_v1/index.md)
- [Sessions](common/protocol_v1/sessions.md)
diff --git a/docs/common/message-workflows.md b/docs/common/message-workflows.md
index 1d9ad6bb..8fa04c43 100644
--- a/docs/common/message-workflows.md
+++ b/docs/common/message-workflows.md
@@ -82,7 +82,7 @@ NIST256P1 public keys.
## SignTx
> The following may contain imprecise/obsolete information. Refer to
-[Bitcoin signing flow](communication/bitcoin-signing.md) for more relevant
+[Bitcoin signing flow](bitcoin-signing.md) for more relevant
information.
Signing a transaction is a little bit complicated. The reason is that
diff --git a/docs/developers/hello_world_in_core.md b/docs/developers/hello_world_in_core.md
index 33cdbcae..070abe52 100644
--- a/docs/developers/hello_world_in_core.md
+++ b/docs/developers/hello_world_in_core.md
@@ -17,7 +17,7 @@ As already mentioned, to get something useful from Trezor, writing device logic
### TLDR: [implementation in a single commit](https://github.com/trezor/trezor-firmware/commit/f43e7828281219b9770eea376e5dd6d5afd6ee3b)
### 1. Communication part (protobuf)
-Communication between Trezor and the computer is handled by a protocol called `protobuf`. It allows for the creation of specific messages (containing clearly defined data) that will be exchanged. More details about this can be seen in [docs](../common/communication/index.md).
+Communication between Trezor and the computer is handled by a protocol called `protobuf`. It allows for the creation of specific messages (containing clearly defined data) that will be exchanged. More details about this can be seen in [docs](../common/index.md).
Trezor on its own cannot send data to the computer, it can only react to a "request" message it recognizes and send a "response" message.
Both of these messages will need to be specified, and both parts of communication will need to understand them.
diff --git a/docs/index.md b/docs/index.md
index e0eb2541..e4bd5d57 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -23,7 +23,7 @@ Welcome to the Trezor Firmware repository. This repository is so called _monorep
## Contribute
-See [CONTRIBUTING.md](https://github.com/trezor/trezor-firmware/tree/main/CONTRIBUTING.md).
+See [CONTRIBUTING.md](misc/contributing.md).
Also please have a look at the docs, either in the `docs` folder or at [docs.trezor.io](https://docs.trezor.io) before contributing. The [misc](misc/index.md) chapter should be read in particular because it contains some useful assorted knowledge.
diff --git a/docs/legacy/firmware-format.md b/docs/legacy/firmware-format.md
index 922c9dc3..eec90d2f 100644
--- a/docs/legacy/firmware-format.md
+++ b/docs/legacy/firmware-format.md
@@ -37,7 +37,7 @@ Signature verification:
## V2 Header
-This header has the same format as [Model T Firmware Header](../model-t/boot.md#firmware-header),
+This header has the same format as [Model T Firmware Header](../core/misc/boot.md#firmware-header),
however due to different signature scheme the `sigmask` and `sig` fields are zeroed and part of the
reserved space is used for T1-specific fields `sig1`-`sig3`, `sigindex1-sigindex3`. Total length of
v2 header is always 1024 bytes.
diff --git a/docs/misc/toif.md b/docs/misc/toif.md
index c34a216e..500f5544 100644
--- a/docs/misc/toif.md
+++ b/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](https://github.com/trezor/trezor-firmware/blob/main/python/tools/toiftool/README.md)
+* [README](../../python/tools/toiftool/README.md)
* [Code](https://github.com/trezor/trezor-firmware/blob/main/python/tools/toiftool/toiftool.py)
diff --git a/docs/python/index.md b/docs/python/index.md
index 877d8ea0..f07f52f9 100644
--- a/docs/python/index.md
+++ b/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](trezorlib.md) for the [PyPI package](https://pypi.org/project/trezor).
+In the meantime see `python/docs` and [README](../../python/README.md) for the [PyPI package](https://pypi.org/project/trezor).
diff --git a/docs/python/trezorlib.md b/docs/python/trezorlib.md
deleted file mode 120000
index 30c63024..00000000
--- a/docs/python/trezorlib.md
+++ /dev/null
@@ -1 +0,0 @@
-../../python/README.md
\ No newline at end of file
Risk score
Our methodology →Why this scored 15/100
Human-validated context
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
No validated notes yet.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.