Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add anchors to documents. #161

Open
wants to merge 1 commit into
base: luds
Choose a base branch
from
Open

Add anchors to documents. #161

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,26 @@ These are all the individual documents describing each small piece of protocol t

| Number | Description | Wallets (in alphabetical order) |
|-------------|-------------------------------------------------------------|---------|
| [01](01.md) | Base LNURL encoding and decoding. | _all the ones listed below_ |
| [02](02.md) | `channelRequest` base spec. | [Balance of Satoshis][balanceofsatoshis], [Blixt][blixt], [Breez][breez], [SimpleBitcoinWallet][sbw], [Zap Android][zap], [Zap Desktop][zap], [Zeus][zeus] |
| [03](03.md) | `withdrawRequest` base spec. | [Balance of Satoshis][balanceofsatoshis], [Blixt][blixt], [BlueWallet][bluewallet], [Breez][breez], [coinos][coinos], [Fountain Podcasts][fountain], [LNbits][lnbits], [@lntxbot][lntxbot], [Muun][muun], [Phoenix][phoenix], [ShockWallet][shockwallet], [SimpleBitcoinWallet][sbw], [ThunderHub][thunderhub], [Wallet of Satoshi][wos], [Zap Android][zap], [Zap Desktop][zap], [Zap iOS][zap], [ZBD Discord][zbd], [ZBD Extension][zbd], [ZBD Telegram][zbd], [ZEBEDEE][zbd], [Zeus][zeus] |
| [04](04.md) | Auth base spec. | [Alby][alby], [Balance of Satoshis][balanceofsatoshis], [Blixt][blixt], [Breez][breez], [coinos][coinos], [LNbits][lnbits], [@lntxbot][lntxbot], [Phoenix][phoenix], [SeedAuth](seedauth), [SeedAuthExtension](sae), [SimpleBitcoinWallet][sbw], [ThunderHub][thunderhub], [Zap Desktop][zap], [Zeus][zeus] |
| [05](05.md) | BIP32-based seed generation for auth protocol. | [coinos][coinos] [SimpleBitcoinWallet][sbw] |
| [06](06.md) | `payRequest` base spec. | [Alby][alby], [Balance of Satoshis][balanceofsatoshis], [Blixt][blixt], [BlueWallet][bluewallet], [Bottlepay][bottlepay], [Breez][breez], [BTCPayServer][btcp], [coinos][coinos], [Fountain Podcasts][fountain], [Galoy][galoy], [LNbits][lnbits], [LNLink][lnlink], [LNPay.co](lnpay), [@lntxbot][lntxbot], [LightningTipBot][ltb], [Phoenix][phoenix], [ShockWallet][shockwallet], [SimpleBitcoinWallet][sbw], [ThunderHub][thunderhub], [Wallet of Satoshi][wos], [Zap Android][zap], [ZBD Discord][zbd], [ZBD Extension][zbd], [ZBD Telegram][zbd], [ZEBEDEE][zbd], [Zeus][zeus] |
| [07](07.md) | `hostedChannelRequest` base spec. | [SimpleBitcoinWallet][sbw] |
| [08](08.md) | Fast `withdrawRequest`. | [@lntxbot][lntxbot], [SimpleBitcoinWallet][sbw], [ZBD Extension][zbd] |
| [09](09.md) | `successAction` field for `payRequest`. | [Alby][alby], [Blixt][blixt], [BlueWallet][bluewallet], [Breez][breez], [coinos][coinos], [Fountain Podcasts][fountain], [LNbits][lnbits], [@lntxbot][lntxbot], [Phoenix][phoenix], [ShockWallet][shockwallet], [SimpleBitcoinWallet][sbw], [ThunderHub][thunderhub], [Wallet of Satoshi][wos], [Zap Android][zap], [ZBD Discord][zbd], [ZBD Extension][zbd], [ZBD Telegram][zbd], [ZEBEDEE][zbd], [Zeus][zeus] |
| [10](10.md) | `aes` success action in `payRequest`. | [Alby][alby], [Blixt][blixt], [BlueWallet][bluewallet], [Breez][breez], [coinos][coinos], [LNbits][lnbits], [@lntxbot][lntxbot], [Phoenix][phoenix], [ShockWallet][shockwallet], [SimpleBitcoinWallet][sbw], [ThunderHub][thunderhub], [Wallet of Satoshi][wos], [Zap Android][zap], [Zeus][zeus] |
| [11](11.md) | Disposable and storeable `payRequest`s. | [Blixt][blixt], [SimpleBitcoinWallet][sbw], [ZBD Extension][zbd] |
| [12](12.md) | Comments in `payRequest`. | [Alby][alby], [Blixt][blixt], [BlueWallet][bluewallet], [Breez][breez], [Fountain Podcasts][fountain], [LNbits][lnbits], [@lntxbot][lntxbot], [Phoenix][phoenix], [ThunderHub][thunderhub], [ZBD Discord][zbd], [ZBD Extension][zbd], [ZBD Telegram][zbd], [ZEBEDEE][zbd], [Zeus][zeus] |
| [13](13.md) | `signMessage`-based seed generation for auth protocol. | [Alby][alby], [Balance of Satoshis][balanceofsatoshis], [Blixt][blixt], [Zeus][zeus] |
| [14](14.md) | `balanceCheck`: reusable `withdrawRequest`s. | [Alby][alby], [Blixt][blixt], [LNbits][lnbits], [@lntxbot][lntxbot] |
| [15](15.md) | `balanceNotify`: services hurrying up the withdraw process. | [LNbits][lnbits], [@lntxbot][lntxbot] |
| [16](16.md) | Paying to static internet identifiers. | [Alby][alby], [Balance of Satoshis][balanceofsatoshis], [Blixt][blixt], [BTCPayServer][btcp], [Fountain Podcasts][fountain], [LNbits][lnbits], [LNLink][lnlink], [@lntxbot][lntxbot], [LightningTipBot][ltb], [Phoenix][phoenix], [SimpleBitcoinWallet][sbw], [Zap Android][zap], [ZBD Discord][zbd], [ZBD Extension][zbd], [ZBD Telegram][zbd], [ZEBEDEE][zbd], [Zeus][zeus] |
| [17](17.md) | Scheme prefixes and raw (non bech32-encoded) URLs. | [Alby][alby], [Blixt][blixt], [BTCPayServer][btcp], [@lntxbot][lntxbot], [ZBD Discord][zbd], [ZBD Telegram][zbd] |
| [18](18.md) | Payer identity in `payRequest` protocol. | [Blixt][blixt], [@lntxbot][lntxbot], [ZBD Discord][zbd], [ZBD Telegram][zbd] |
| [19](19.md) | Pay link discoverable from withdraw link. | [Blixt][blixt], [SimpleBitcoinWallet][sbw] |
| [20](20.md) | Long payment description for pay protocol. | [Alby][alby], [Blixt][blixt], [@lntxbot][lntxbot], [Phoenix][phoenix] |
| [01](01.md) <a id="lnurl-document-01"></a> | Base LNURL encoding and decoding. | _all the ones listed below_ |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm how would it look with hashtag as the text for the tag? Otherwise it would be a hidden feature that few know about.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hashtag?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| [01](01.md) <a id="lnurl-document-01"></a> | Base LNURL encoding and decoding. | _all the ones listed below_ |
| [01](01.md) <a id="lnurl-document-01">#</a> | Base LNURL encoding and decoding. | _all the ones listed below_ |

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that this is not a link, but an anchor. It is a with id, not with href. It is not supposed to have any text because it is not linking anywhere, but rather it is used to be linked to.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, yes it could be done to a link by just adding href too <a href="#lnurl-document-01" id="lnurl-document-01">#</a>...

I don't see the usefulness if no one would know about this feature.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are suggesting to actually create a link to itself with "#" as a text? That would work, but it seems very strange. Have you ever seen that anywhere on the web?

What do you mean by "nobody would know about it"? This is how links work in HTML. Say, I want to link to a specific section inside a Wikipedia article, I would do it by using # and the ID of the element, like this: https://en.wikipedia.org/wiki/Padua#By_rail There is absolutely no visual indication that that element can be linked to, and yet people do this all the time - perhaps by using "view source" or the inspector? Or just guessing? I don't know. But there is no actual link in there, just a HTML element with an ID that can be linked to.

Anyway, I am happy to do whatever works for you, as long as we simplify the user experience. Currently, a web site doing Lightning log in, like stacker.news, will link to #lnurl-documents and it is completely not obvious for anyone that is not a Lightning developer that they need to look at "04".

Alternatively, we could maybe add a more user-friendly paragraph and link to that?

The problem now is that more and more websites are using Lightning log in, so we need to make it easily accessible to people who are using a Lightning wallet to log in for the first time.

No need to merge this if you don't like it, but at least I started a discussion about this, and hopefully there are other suggestions as well. https://lightninglogin.live/ is also nice BTW, but it seems more targeted to developers. Maybe something like that but with the user in mind would do, a page explaining Lightning log in for the final user, that anyone can link to from their log in pages? Perhaps hosted on GitHub Pages, so it doesn't disappear if we forget to renew the domain?

| [02](02.md) <a id="lnurl-document-02"></a> | `channelRequest` base spec. | [Balance of Satoshis][balanceofsatoshis], [Blixt][blixt], [Breez][breez], [SimpleBitcoinWallet][sbw], [Zap Android][zap], [Zap Desktop][zap], [Zeus][zeus] |
| [03](03.md) <a id="lnurl-document-03"></a> | `withdrawRequest` base spec. | [Balance of Satoshis][balanceofsatoshis], [Blixt][blixt], [BlueWallet][bluewallet], [Breez][breez], [coinos][coinos], [Fountain Podcasts][fountain], [LNbits][lnbits], [@lntxbot][lntxbot], [Muun][muun], [Phoenix][phoenix], [ShockWallet][shockwallet], [SimpleBitcoinWallet][sbw], [ThunderHub][thunderhub], [Wallet of Satoshi][wos], [Zap Android][zap], [Zap Desktop][zap], [Zap iOS][zap], [ZBD Discord][zbd], [ZBD Extension][zbd], [ZBD Telegram][zbd], [ZEBEDEE][zbd], [Zeus][zeus] |
| [04](04.md) <a id="lnurl-document-04"></a>| Auth base spec. | [Alby][alby], [Balance of Satoshis][balanceofsatoshis], [Blixt][blixt], [Breez][breez], [coinos][coinos], [LNbits][lnbits], [@lntxbot][lntxbot], [Phoenix][phoenix], [SeedAuth](seedauth), [SeedAuthExtension](sae), [SimpleBitcoinWallet][sbw], [ThunderHub][thunderhub], [Zap Desktop][zap], [Zeus][zeus] |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing a space here

| [05](05.md) <a id="lnurl-document-05"></a> | BIP32-based seed generation for auth protocol. | [coinos][coinos] [SimpleBitcoinWallet][sbw] |
| [06](06.md) <a id="lnurl-document-06"></a> | `payRequest` base spec. | [Alby][alby], [Balance of Satoshis][balanceofsatoshis], [Blixt][blixt], [BlueWallet][bluewallet], [Bottlepay][bottlepay], [Breez][breez], [BTCPayServer][btcp], [coinos][coinos], [Fountain Podcasts][fountain], [Galoy][galoy], [LNbits][lnbits], [LNLink][lnlink], [LNPay.co](lnpay), [@lntxbot][lntxbot], [LightningTipBot][ltb], [Phoenix][phoenix], [ShockWallet][shockwallet], [SimpleBitcoinWallet][sbw], [ThunderHub][thunderhub], [Wallet of Satoshi][wos], [Zap Android][zap], [ZBD Discord][zbd], [ZBD Extension][zbd], [ZBD Telegram][zbd], [ZEBEDEE][zbd], [Zeus][zeus] |
| [07](07.md) <a id="lnurl-document-07"></a> | `hostedChannelRequest` base spec. | [SimpleBitcoinWallet][sbw] |
| [08](08.md) <a id="lnurl-document-08"></a> | Fast `withdrawRequest`. | [@lntxbot][lntxbot], [SimpleBitcoinWallet][sbw], [ZBD Extension][zbd] |
| [09](09.md) <a id="lnurl-document-09"></a> | `successAction` field for `payRequest`. | [Alby][alby], [Blixt][blixt], [BlueWallet][bluewallet], [Breez][breez], [coinos][coinos], [Fountain Podcasts][fountain], [LNbits][lnbits], [@lntxbot][lntxbot], [Phoenix][phoenix], [ShockWallet][shockwallet], [SimpleBitcoinWallet][sbw], [ThunderHub][thunderhub], [Wallet of Satoshi][wos], [Zap Android][zap], [ZBD Discord][zbd], [ZBD Extension][zbd], [ZBD Telegram][zbd], [ZEBEDEE][zbd], [Zeus][zeus] |
| [10](10.md) <a id="lnurl-document-10"></a>| `aes` success action in `payRequest`. | [Alby][alby], [Blixt][blixt], [BlueWallet][bluewallet], [Breez][breez], [coinos][coinos], [LNbits][lnbits], [@lntxbot][lntxbot], [Phoenix][phoenix], [ShockWallet][shockwallet], [SimpleBitcoinWallet][sbw], [ThunderHub][thunderhub], [Wallet of Satoshi][wos], [Zap Android][zap], [Zeus][zeus] |
| [11](11.md) <a id="lnurl-document-11"></a> | Disposable and storeable `payRequest`s. | [Blixt][blixt], [SimpleBitcoinWallet][sbw], [ZBD Extension][zbd] |
| [12](12.md) <a id="lnurl-document-12"></a> | Comments in `payRequest`. | [Alby][alby], [Blixt][blixt], [BlueWallet][bluewallet], [Breez][breez], [Fountain Podcasts][fountain], [LNbits][lnbits], [@lntxbot][lntxbot], [Phoenix][phoenix], [ThunderHub][thunderhub], [ZBD Discord][zbd], [ZBD Extension][zbd], [ZBD Telegram][zbd], [ZEBEDEE][zbd], [Zeus][zeus] |
| [13](13.md) <a id="lnurl-document-13"></a> | `signMessage`-based seed generation for auth protocol. | [Alby][alby], [Balance of Satoshis][balanceofsatoshis], [Blixt][blixt], [Zeus][zeus] |
| [14](14.md) <a id="lnurl-document-14"></a> | `balanceCheck`: reusable `withdrawRequest`s. | [Alby][alby], [Blixt][blixt], [LNbits][lnbits], [@lntxbot][lntxbot] |
| [15](15.md) <a id="lnurl-document-15"></a> | `balanceNotify`: services hurrying up the withdraw process. | [LNbits][lnbits], [@lntxbot][lntxbot] |
| [16](16.md) <a id="lnurl-document-16"></a> | Paying to static internet identifiers. | [Alby][alby], [Balance of Satoshis][balanceofsatoshis], [Blixt][blixt], [BTCPayServer][btcp], [Fountain Podcasts][fountain], [LNbits][lnbits], [LNLink][lnlink], [@lntxbot][lntxbot], [LightningTipBot][ltb], [Phoenix][phoenix], [SimpleBitcoinWallet][sbw], [Zap Android][zap], [ZBD Discord][zbd], [ZBD Extension][zbd], [ZBD Telegram][zbd], [ZEBEDEE][zbd], [Zeus][zeus] |
| [17](17.md) <a id="lnurl-document-17"></a> | Scheme prefixes and raw (non bech32-encoded) URLs. | [Alby][alby], [Blixt][blixt], [BTCPayServer][btcp], [@lntxbot][lntxbot], [ZBD Discord][zbd], [ZBD Telegram][zbd] |
| [18](18.md) <a id="lnurl-document-18"></a> | Payer identity in `payRequest` protocol. | [Blixt][blixt], [@lntxbot][lntxbot], [ZBD Discord][zbd], [ZBD Telegram][zbd] |
| [19](19.md) <a id="lnurl-document-19"></a> | Pay link discoverable from withdraw link. | [Blixt][blixt], [SimpleBitcoinWallet][sbw] |
| [20](20.md) <a id="lnurl-document-20"></a> | Long payment description for pay protocol. | [Alby][alby], [Blixt][blixt], [@lntxbot][lntxbot], [Phoenix][phoenix] |

[alby]: https://github.com/getAlby/lightning-browser-extension
[balanceofsatoshis]: https://github.com/alexbosworth/balanceofsatoshis
Expand Down