dcrdocs icon indicating copy to clipboard operation
dcrdocs copied to clipboard

Published 20 hours ago • verified publisher icon decred

Add Lightning to docs

Open s-ben opened this issue 5 years ago • 9 comments

The technical documentation for our Lightning Network implementation lives in the dcrlnd repo, as it should. However, now that LND is officially launched, it seems awkward to not have Lightning mentioned in the official docs. I propose adding at least a general overview page, which points to the technical docs and any other resources that might be useful.

s-ben avatar May 22 '19 20:05 s-ben

I would like to see LN well documented, basically have as much info as we can about how it works, any differences to BTC/LTC, how to set up nodes and channels, etc.

RichardRed0x avatar May 22 '19 23:05 RichardRed0x

Thoughts on where a page would go? It doesn't seem to fit under any of the top menus. Just make a top-level Lightning (LND) menu? Or Layer 2 menu with Lightning subpage?

s-ben avatar May 23 '19 06:05 s-ben

For now at least I would suggest adding it under the existing Wallets menu. Right now, LN is its own wallet, separate to dcrwallet. It might look the same because it is exposed via Decrediton, but they are totally independent tools.

jholdstock avatar May 23 '19 11:05 jholdstock

Under Wallets makes sense then. I could create a decent high-level description of our LN implementation, but not familiar with the wallet aspects. Also wondering what level of technical detail is appropriate here wrt LN being in its own wallet.

s-ben avatar May 23 '19 20:05 s-ben

Taking a stab at a first draft.

s-ben avatar May 29 '19 04:05 s-ben

Hello guys, do you need some help? Now with dcrwallet implemented to dcrlnd, I think that Lightning needs an item on top-vel menu and a basic explain. How to run the CLI and how the network works is more for devdocs, what you think?

fguisso avatar Dec 22 '19 20:12 fguisso

Hey @fguisso, was just wondering about this actually. Dcrdocs is more user-facing. If LN is exposed via any interface (Decrediton or CLI) that is ready for actual usage, I'd say we should document that on the LN page ASAP.

Advanced functionality only a dev would use, I'd say put it in devdocs.

s-ben avatar Dec 25 '19 05:12 s-ben

I think we have two things to document here:

  • General LN info and concepts - what its good for, how it works. This could be done at any time
  • How to use DCR LN - CLI and/or Decrediton. Should only be done when available and ready for end-users

jholdstock avatar Jan 08 '20 08:01 jholdstock

Agreed. We could probably add general LN info and concepts now @fguisso if you want to take a stab.

s-ben avatar Jan 09 '20 20:01 s-ben