Repository navigation
docs: Distinguish handwritten look-alikes - #134
BenWestgate wants to merge 1 commit into
Conversation
Add the drafting conventions already used by the codex32 recovery material to the printable card and user guide so operators can distinguish the characters most likely to be confused during transcription. Fixes #108
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5453c63229
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| <span class="group"></span><span class="group"></span><span class="group"></span><span class="group"></span> | ||
| </div> | ||
| <p class="small">Leave unused boxes blank.</p> | ||
| <p class="small"><strong>Handwriting legend:</strong> draw S with a vertical stroke ($), slash 0, cross Z and 7, and give 5 a flat top. O, I, and B are not codex32 characters; a written O can only mean 0.</p> |
There was a problem hiding this comment.
Limit the excluded-letter claim to the data part
For generic codex32 artifacts, O, I, and B may legally appear in the application prefix before the 1 separator: bech32_decode() accepts any printable single-case ASCII HRP and applies the restricted charset only after the separator. An operator following “a written O can only mean 0” could therefore corrupt a valid opaque-HRP backup during transcription. Clarify that these letters are excluded only from the encoded data portion, or explicitly exempt the application prefix.
Useful? React with 👍 / 👎.
|
|
||
| Before running `create` for a real wallet, have your blank cards, a pen, and | ||
| wallet record ready, and choose separate trusted places for shared cards. | ||
| When handwriting recovery text, follow the card legend: stroke S, slash 0, cross Z and 7, and give 5 a flat top; O, I, and B are not codex32 characters. |
There was a problem hiding this comment.
Wrap the new documentation lines
This added guide line is 152 characters, and the parallel recovery-card legend is 210 characters, so both exceed the repository's 110-character limit and depart from the wrapped style used by the surrounding documentation. Wrap both additions into shorter source lines without changing their rendered prose.
AGENTS.md reference: AGENTS.md:L54-L59
Useful? React with 👍 / 👎.
BenWestgate
left a comment
There was a problem hiding this comment.
AI-assisted current-head docs review: ACK 5453c63. The guide and blank recovery card give the same practical handwriting key. No code or recovery-behavior changes.
What
Add the recovery-card handwriting legend requested in #108: stroke S, slash 0, cross Z and 7, and give 5 a flat top. The user guide points operators to the same convention and notes that O, I, and B are not codex32 characters.
Why
A field tester confused 5/S and O/0 while copying recovery material. Confirmation caught the error, but the printed card should prevent the ambiguity before recovery is needed.
Review shape
One documentation-only commit, two added lines, no runtime code changes.
Verification
Compared directly with current
reviewability-v1: one commit ahead, two files changed, one added line in each file.Fixes #108.
AI assistance prepared this focused documentation patch; responsible-human review and integration remain required.