bolts
bolts copied to clipboard
lightning
A home for BOLT
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 domain ln.dev a while ago, I thought it would make just the home the BOLT specs deserve.
Benefits compared to current GitHub-only hosting:
- Easy to remember domain, no need to google for the specs link
- Easy-to-use search function (no fiddling with google search parameters or git clone+editor search)
- Better overview (overview panel left, content panel right)
- Reading mode (bottom next page card)
- Better Google indexing & visibility (hopefully)
- Useful links for spec newbies without cluttering the specs itself (added some samples)
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.
Failed Travis build: the spellchecker doesn't like the word "Explainer". Well, that's fixable.
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.
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):
- merge this
- add my github handle with read access to this repo (gitbook needs this)
@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.
@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?
I was following the convo. Using a fork is definitely possible. Pro:
- Advantage of the fork would be that one can modify things slightly, e.g. have BOLT #0 as landing page instead of the current README. But doesn't have to be.
Con:
- Whoever creates the fork needs to keep it up-to-date (prbly @rustyrussell ). I think it's a good idea to automate this to keep people from bugging.
- "Edit on GitHub" button can't be used since this would link to the fork, but the header GitHub link can link to the main repo.
@rustyrussell should get in touch with you shortly concerning the ln.dev hostname, thanks for proposing this.
-> 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 ln.dev neither. Currently checking with my registrar if it's possible to simply pay now and you getting 1 year free after transfer).
EDIT: Possible. It'll come prepaid til 2021-02-22.
- Removed v1.1 proposal states as discussed
- Brought it live at https://ln.dev/ to test if my lil CNAME trick worked
- I'm in touch with Rusty, hand-over is in progress