bitcoinafterlife
fb1c5ec4b2
Some checks failed
Build and deploy docs / deploy (push) Failing after 1s
136 lines
7.2 KiB
Markdown
136 lines
7.2 KiB
Markdown
# Screenshots — how to produce and replace them
|
||
|
||
## The short version
|
||
|
||
Every image in the manual is listed in **`screenshots.yml`** at the project root.
|
||
To replace one, save your screenshot as `docs/img/<filename>` using **exactly** the
|
||
filename from the manifest. No Markdown edit is needed — the pages already point there.
|
||
|
||
```bash
|
||
python3 tools/make_placeholders.py --list # what's still missing
|
||
python3 tools/make_placeholders.py # fill gaps with placeholders
|
||
```
|
||
|
||
Placeholders never overwrite a real image.
|
||
|
||
## Capture rules — keep these identical everywhere
|
||
|
||
- **Electrum window only**, not the whole desktop.
|
||
- Windows: ++win+shift+s++ (Snipping Tool) or use `grim -g "$(slurp)" shot.png` if you prefer
|
||
- macOS: ++cmd+shift+4++ then ++space++ to capture a window
|
||
- Linux: `gnome-screenshot -w` or `import -window root shot.png` (ImageMagick)
|
||
- **1280×720** at system zoom 100%** — this matches Electrum's typical window size when maximized on a laptop.
|
||
- **Light theme** (default Electrum) for consistency. Never mix light and dark.
|
||
- **PNG** format, no JPEG.
|
||
- **Crop tightly** to the Electrum window; include title bar and the relevant tab/dialog.
|
||
|
||
## Setting up the test wallet
|
||
|
||
Use **testnet** (not mainnet) so no real Bitcoin is at risk. In Electrum:
|
||
1. Create → New wallet
|
||
2. Name: `Screenshot_Test` or similar (will show in the title bar)
|
||
3. Standard wallet → Create new seed
|
||
4. Write down the seed (you'll need to restore it later)
|
||
5. Set a simple password like `test` (will be shown in password dialogs)
|
||
6. In Electrum's Network tab, switch to testnet servers
|
||
|
||
Get testnet Bitcoin from a faucet (e.g. testnet-faucet.mempool.space) to populate the wallet so screenshots show real-looking balances.
|
||
|
||
## Data hygiene — this is the important part
|
||
|
||
Screenshots of an inheritance plugin leak real information if you are careless.
|
||
|
||
- Use the **dedicated testnet wallet** set up above.
|
||
- **Fake heir names** (Jonny, Andrea, Emma — as in the original manual).
|
||
- **Round, obviously fake amounts** (0.05 BTC, 0.1 BTC, never suspicious multiples like 0.0314 BTC).
|
||
- **No real Bitcoin address** that belongs to you or anyone you know — use generated testnet addresses or Bitcoin StackExchange examples.
|
||
- **Obfuscate file paths**: the title bar will show your wallet filename. Use a generic name like `Screenshot_Test`, not `MyWallet_MainAccount`.
|
||
- Check the window title bar, the status bar, tooltips, and any dialogs — they often contain a username or a real wallet filename. Crop or blur them if necessary.
|
||
|
||
## Annotations
|
||
|
||
If you add arrows or highlight boxes, keep one consistent style across the whole manual:
|
||
same colour, same stroke width, same arrowhead. Inconsistent annotation looks worse than none.
|
||
|
||
## The 24 screenshots — what to capture
|
||
|
||
All are from the **HEIRS and WILL tabs** or the **startup wizard**. Placeholder images already exist in `docs/img/`; replace them with real shots.
|
||
|
||
### Installation & setup (6 images)
|
||
|
||
| File | Where | What to show |
|
||
|---|---|---|
|
||
| `install-electrum-plugins-menu.png` | Electrum → Tools → Plugins | The "Plugins" dialog with built-in plugins listed. Show the internal plugins, and note the "Add" button for external plugins. |
|
||
| `install-from-file.png` | Electrum → Tools → Plugins → Add | File selector dialog, pointing to the BAL `.zip` file. |
|
||
| `install-plugin-enabled.png` | Electrum → Tools → Plugins | Plugin list with "Bitcoin After Life" checked/enabled. |
|
||
| `overview-tabs.png` | Electrum main window | The Electrum window with HEIRS and WILL tabs visible. Show the tab bar clearly. |
|
||
| `hardware-wallet-signing.png` | During signing on a hardware wallet | A hardware wallet confirmation screen (Ledger, Trezor, etc.) asking the user to confirm. If you don't have one, skip and update the manual to note it's optional. |
|
||
| `welist-website.png` | https://welist.bitcoin-after.life/ | The WeList website showing available Will-Executors and their fees. |
|
||
|
||
### Wizard — 5 steps (5 images)
|
||
|
||
Start the wizard from **HEIRS → Add new heir → (wizard opens)**.
|
||
|
||
| File | Wizard step | What to show |
|
||
|---|---|---|
|
||
| `wizard-01-start.png` | Welcome screen | The first wizard dialog with the title and brief explanation. |
|
||
| `wizard-02-heirs.png` | Add heirs | A few heir rows filled in: e.g., Jonny (50%), Andrea (50%), with Bitcoin addresses. |
|
||
| `wizard-03-delivery-time.png` | Delivery date | The date/time picker. Show either the calendar view or the Raw input field. |
|
||
| `wizard-04-willexecutors.png` | Select Will-Executors | The list of available Will-Executors from WeList with checkboxes, fees visible. Check a few (e.g., 3–4 servers). |
|
||
| `wizard-05-summary.png` | Review & sign | The final summary showing all choices: heirs, date, servers, total fee. |
|
||
|
||
### HEIRS tab (3 images)
|
||
|
||
| File | What to show |
|
||
|---|---|
|
||
| `heirs-tab.png` | The HEIRS tab overview with a list of added heirs (if any). |
|
||
| `heirs-new-heir.png` | The "Add new heir" button or dialog. |
|
||
| `heirs-export.png` | The export dialog/list (if available in the plugin UI). |
|
||
|
||
### WILL tab (3 images)
|
||
|
||
| File | What to show |
|
||
|---|---|
|
||
| `will-tab.png` | The WILL tab with one or more inheritance transactions listed. Show the columns and status. |
|
||
| `will-server-column.png` | Zoom in on the "Server" column showing the 5 textual states (OK, pending, awaiting first broadcast, unknown, overdue). |
|
||
| `will-context-menu.png` | Right-click on a will entry to show the context menu (e.g., "View details", "Copy fee address", etc.). |
|
||
| `will-details.png` | The details dialog for a single will, showing transaction data, date, servers, status. |
|
||
|
||
### Backup & signing (3 images)
|
||
|
||
| File | Where | What to show |
|
||
|---|---|---|
|
||
| `backup-transaction-save.png` | WILL tab → right-click → Backup transaction | File save dialog, showing the default `.psbt` filename. |
|
||
| `settings-*.png` (general, auth, advanced) | HEIRS or WILL tab settings | Plugin settings dialogs (if they exist in the UI). Capture the "General", "Authentication", and "Advanced" tabs or panels. |
|
||
|
||
### Check Alive (advanced mode) (1 image)
|
||
|
||
| File | Where | What to show |
|
||
|---|---|---|
|
||
| `check-alive-prompt.png` | Opening the wallet after Check Alive triggers | The dialog asking the user to refresh the will. |
|
||
|
||
---
|
||
|
||
## Workflow to capture all 24
|
||
|
||
1. **Set up testnet wallet** (see "Setting up the test wallet" above).
|
||
2. **Install BAL plugin** in your Electrum instance.
|
||
3. **Go through the wizard** once to understand the flow, then capture each step.
|
||
4. **Create a few test wills** (different dates, different heir counts) so you have variety for the WILL tab screenshots.
|
||
5. **Capture the HEIRS tab** at various states (empty, with heirs, export dialog).
|
||
6. **Capture the WILL tab** at various states (wills in different states, details dialog, context menus).
|
||
7. **Save each** as `docs/img/<filename>` using the names from the table above.
|
||
8. **Run** `python3 tools/make_placeholders.py --list` to verify all 24 are found (should show 0 missing).
|
||
|
||
## Adding a new image
|
||
|
||
1. Add an entry to `screenshots.yml` (`file`, `page`, `shows`).
|
||
2. Reference it in the page:
|
||
|
||
```markdown
|
||
{ .screenshot }
|
||
*Caption line.*
|
||
```
|
||
|
||
3. Run `python3 tools/make_placeholders.py` so the build stays green until the real shot exists.
|