upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBitflash <btf01@proton.me>2026-08-04 10:19:38 -0300
committerGitHub <noreply@github.com>2026-08-04 10:19:38 -0300
commita2592156207ed04671d6532cec4997fb1dab1595 (patch)
tree6355a64910d83f0901437eebd59fbc0e04db1712
parentf6c5b813075cae4228d241a3567e70b210504749 (diff)
docs: one documentation directory, not two (#137)
docs/ has held the README's images since the fair-launch release. I added doc/ yesterday for the derivation spec without looking, and #108 then correctly used docs/ -- leaving the repository with both, one letter apart, which is the kind of thing that quietly costs someone ten minutes a year forever. The mistake was mine, so the move is mine: derivation.md and verify-derivation.py go to docs/, and the two README links follow. No content changes. The verifier still reproduces the wallet from its new path, which is the only thing here that can actually break.
-rw-r--r--README.md2
-rw-r--r--docs/derivation.md (renamed from doc/derivation.md)4
-rw-r--r--docs/verify-derivation.py (renamed from doc/verify-derivation.py)0
3 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 6446b3d..6746e02 100644
--- a/README.md
+++ b/README.md
@@ -107,7 +107,7 @@ words also cover the address the window shows you. **Both still matter** — the
107phrase and the file back up different things, and the difference is where people 107phrase and the file back up different things, and the difference is where people
108lose money. 108lose money.
109 109
110The derivation is written down in [doc/derivation.md](doc/derivation.md), with 110The derivation is written down in [docs/derivation.md](docs/derivation.md), with
111test vectors and a script that reproduces them from scratch. It is there so the 111test vectors and a script that reproduces them from scratch. It is there so the
112twelve words keep working even if this software does not: paths, address format 112twelve words keep working even if this software does not: paths, address format
113and encoding, enough to recover the keys with ordinary tools and no Bitflash 113and encoding, enough to recover the keys with ordinary tools and no Bitflash
diff --git a/doc/derivation.md b/docs/derivation.md
index 3ca8339..c5ee3ad 100644
--- a/doc/derivation.md
+++ b/docs/derivation.md
@@ -5,7 +5,7 @@ software**. If the project stops, the binaries are lost, or you simply do not
5trust them, the twelve words plus what is written here are enough to recover 5trust them, the twelve words plus what is written here are enough to recover
6your private keys with ordinary cryptographic tools. 6your private keys with ordinary cryptographic tools.
7 7
8Everything below is verified by `doc/verify-derivation.py`, a self-contained 8Everything below is verified by `docs/verify-derivation.py`, a self-contained
9script that implements this document from scratch — no Bitflash code, no 9script that implements this document from scratch — no Bitflash code, no
10libraries beyond Python's standard library — and checks that it reproduces the 10libraries beyond Python's standard library — and checks that it reproduces the
11addresses the wallet produces. If the two ever disagree, this document is wrong 11addresses the wallet produces. If the two ever disagree, this document is wrong
@@ -106,7 +106,7 @@ abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon
106Check them yourself: 106Check them yourself:
107 107
108``` 108```
109python doc/verify-derivation.py 109python docs/verify-derivation.py
110``` 110```
111 111
112Both tables were produced by the wallet — the legacy one by the v1.2.15 binary, 112Both tables were produced by the wallet — the legacy one by the v1.2.15 binary,
diff --git a/doc/verify-derivation.py b/docs/verify-derivation.py
index ba8e883..ba8e883 100644
--- a/doc/verify-derivation.py
+++ b/docs/verify-derivation.py