feat: improve UX terminology and add comprehensive documentation #58
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
arcbtc
reviewed
Nov 17, 2025
Member
arcbtc
left a comment
arcbtc
left a comment
There was a problem hiding this comment.
Use of the term "cash out" is misleading, as its a swap between ln/liquid/onchain.
Cashout implies swapping to fiat.
Member
|
I like the pr a lot though. Low hanging UX improvement |
Contributor
Author
Good point. What should we put? |
Contributor
Author
Suggest renaming:
I also think the drop downs aren't immediately clear. Suggest changing the Asset drop downs change:
|
arcbtc
approved these changes
Dec 22, 2025
Member
|
LGTM |
dni
approved these changes
Dec 22, 2025
This PR improves the user experience for non-technical users and addresses issues lnbits#54, lnbits#55, and lnbits#46. **UX Improvements:** - Replace technical jargon with user-friendly terminology - "Onchain to LN" → "Receive from onchain" - "LN to Onchain" → "Send to Bitcoin address" - "Autoswap LN to Onchain" → "Auto Cash Out to Bitcoin" - Add helpful tooltips to all action buttons - Include introductory text in each dialog explaining its purpose - Add field hints with examples to guide users - Change section headings from arrows (→) to "to" for clarity **Documentation Enhancements:** - Add Boltz banner image to right sidebar - Create separate "About Boltz" section - Restructure "Usage Guide" to explain Swap IN, Swap OUT, and Auto Cash Out - Expand API documentation with detailed endpoint info (similar to allowance extension) - Include HTTP methods, headers, body parameters, and response formats - Provide working curl examples for each endpoint - Add "Share Feedback on GitHub" button to Help section **Bug Fixes:** - Fix lnbits#46: Min and max values now persist when canceling and reopening dialogs - Add proper initialization methods that reset dialog data before opening - Ensures asset is always set to default 'BTC/BTC' when opening dialogs **Files Changed:** - Updated description.md with user-friendly language and real-world use cases - Replaced _api_docs.html with _info_sections.html for better organization - Created _intro.html for banner and introduction text - Added boltz-banner.png image asset 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Make the introductory text in all three dialogs more readable by changing from grey to white. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Changed "Create Auto Reverse Swap (Out)" to "Enable Auto Cash Out" for consistency with other button labels. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Made the tooltips for the two advanced options more user-friendly: - Balance to keep: Now explains it's the minimum Lightning balance kept after each automatic cash out plus fee reserve - Fee limit: Now explains it skips swaps during high fee periods 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
dni
force-pushed
the
improve-ux-terminology
branch
from
a8b3fd3 to
6a9f01b
Compare
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This was referenced Dec 22, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves the user experience for non-technical users by replacing technical jargon with user-friendly terminology and adds comprehensive documentation to the extension.
My use case for implementation was so that it is a little more intuitive for my daughter who uses this to send funds from here to her Bitcoin balance on Revolut so she can use her Mastercard to make purchases using Bitcoin.
Issues Addressed
Changes Made
UX Improvements
Documentation Enhancements
Right Sidebar Restructuring:
API Documentation: Expanded to match allowance extension format
Bug Fixes
openSubmarineSwapDialog(), etc.)Files Changed
description.md- Updated with user-friendly language and real-world use casestemplates/boltz/_api_docs.html- Replaced with_info_sections.htmlfor better organizationtemplates/boltz/_intro.html- New file for banner and introduction textstatic/image/boltz-banner.png- New custom banner imageFYI @EdiWeeks @arcbtc
🤖 Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com