-
Notifications
You must be signed in to change notification settings - Fork 493
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.
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
A home for BOLT #738
A home for BOLT #738
Conversation
Failed Travis build: the spellchecker doesn't like the word "Explainer". Well, that's fixable. |
I think this is a good idea. It's low maintenance so quite worth it. |
Thanks @t-bast ! Let's wait for some more opinions. Deadline where I need to decide what to do with the domain is in ~2 weeks (domain renewal fee is due). Travis build fixed. |
SUMMARY.md
Outdated
|
||
## Proposals | ||
|
||
* [Proposal States](https://github.com/lightningnetwork/lightning-rfc/wiki/Lightning-Specification-1.1-Proposal-States) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure this is kept up-to-date. For the proposals maybe I'd list to the open PRs instead:
https://github.com/lightningnetwork/lightning-rfc/pulls
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can do @cdecker @renepickhardt wdyt?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd simply remove this since indeed this doesn't seem to be maintained very much (and clicking on "GitHub", then PRs should be a no-brainer).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed.
@cdecker @rustyrussell WDYT? |
Christian looks supportive, two things that would need to be done to get this live at https://ln.dev/ (considering folks are ok with me holding the domain):
|
Sounds good to me, might be nice to have a short URL to send users to. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@URoZYMP43wPs this is cool, i'm also in favor. much easier to browse than github.
SUMMARY.md
Outdated
* [BOLT \#3: Transactions](read/03-transactions.md) | ||
* [BOLT \#4: Onion Routing](read/04-onion-routing.md) | ||
* [BOLT \#5: On-chain](read/05-onchain.md) | ||
* [BOLT \#6: DEPRECATED](https://github.com/lightningnetwork/lightning-rfc/issues/551) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
imo we don't need to display BOLT 6, but we can keep if others feel strongly
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fwiw i really like having the explanation for its exclusion linked, much like the "this page intentionally left blank" notes on legal docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd also vouch for keeping this since the GitBook site is rather targeting spec newbies (who I bet will ask themselves what happened to BOLT #6 - at least I did).
@URoZYMP43wPs do you think this summary.md really needs to be in the main repo? The point was raised during yesterday's meeting and there was feedback saying that this could easily be done in a fork. Do you know if that would cause issues? @rustyrussell should get in touch with you shortly concerning the ln.dev hostname, thanks for proposing this. |
I was following the convo. Using a fork is definitely possible.
Con:
-> URoZYMP43wPs [ɛt] protonmail @rustyrussell (Yes I'm happy to transfer the domain to you and yes I will try to find a way to pay for the coming year. Don't want to see an altcoin site on EDIT: Possible. It'll come prepaid til 2021-02-22. |
|
Looks like this died down, closing this inactive PR. |
This PR adds
SUMMARY.md
for a nice-looking GitBook integration. For those who don't know GitBook: it takes markdown files hosted on GitHub as source and displays them in a readable manner as HTML website. It's used by numerous projects, e.g. the Lightning Wiki by Radar. As I happened to purchase the domainln.dev
a while ago, I thought it would make just the home the BOLT specs deserve.Benefits compared to current GitHub-only hosting:
Should be low maintenance, since
SUMMARY.md
only requires changes when a BOLT is added/removed.Here a preview of how the final result could look like: https://ln.dev/
If y'all find this useful, I'd be open to donate the domain to someone in the rfc team. Just be aware, that thanks to not-evil Google the yearly renewal fee is ~900 USD. I'd also be open to sponsor the domain for some years. I can also look into something else than GitBook, if you don't like it for some reason.