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.

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

Open
wants to merge 5 commits into
base: master
from
Open

Conversation

@URoZYMP43wPs
Copy link

URoZYMP43wPs commented Feb 6, 2020

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://preview.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.

@URoZYMP43wPs

This comment has been minimized.

Copy link
Author

URoZYMP43wPs commented Feb 6, 2020

Failed Travis build: the spellchecker doesn't like the word "Explainer". Well, that's fixable.

@t-bast

This comment has been minimized.

Copy link
Collaborator

t-bast commented Feb 6, 2020

I think this is a good idea. It's low maintenance so quite worth it.

@URoZYMP43wPs

This comment has been minimized.

Copy link
Author

URoZYMP43wPs commented Feb 7, 2020

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)

This comment has been minimized.

Copy link
@t-bast

t-bast Feb 7, 2020

Collaborator

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

This comment has been minimized.

Copy link
@URoZYMP43wPs

This comment has been minimized.

Copy link
@URoZYMP43wPs

URoZYMP43wPs Feb 18, 2020

Author

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).

@t-bast

This comment has been minimized.

Copy link
Collaborator

t-bast commented Feb 7, 2020

@URoZYMP43wPs

This comment has been minimized.

Copy link
Author

URoZYMP43wPs commented Feb 12, 2020

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)
@cdecker

This comment has been minimized.

Copy link
Collaborator

cdecker commented Feb 14, 2020

Sounds good to me, might be nice to have a short URL to send users to.

@cdecker cdecker mentioned this pull request Feb 14, 2020
5 of 12 tasks complete
Copy link
Collaborator

cfromknecht left a comment

@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)

This comment has been minimized.

Copy link
@cfromknecht

cfromknecht Feb 14, 2020

Collaborator

imo we don't need to display BOLT 6, but we can keep if others feel strongly

This comment has been minimized.

Copy link
@niftynei

niftynei Feb 17, 2020

Collaborator

fwiw i really like having the explanation for its exclusion linked, much like the "this page intentionally left blank" notes on legal docs.

This comment has been minimized.

Copy link
@t-bast

t-bast Feb 18, 2020

Collaborator

Same!

This comment has been minimized.

Copy link
@URoZYMP43wPs

URoZYMP43wPs Feb 18, 2020

Author

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).

@t-bast

This comment has been minimized.

Copy link
Collaborator

t-bast commented Feb 18, 2020

@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

This comment has been minimized.

Copy link
Author

URoZYMP43wPs commented Feb 18, 2020

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants
You can’t perform that action at this time.