Add Lightning to docs - Githubissues

decred / dcrdocs

Documentation for Decred.

https://docs.decred.org

ISC License

81 stars 129 forks source link

Add Lightning to docs #946

Open s-ben opened 5 years ago

s-ben commented 5 years ago

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.

RichardRed0x commented 5 years ago

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.

s-ben commented 5 years ago

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?

jholdstock commented 5 years ago

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.

s-ben commented 5 years ago

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 commented 5 years ago

Taking a stab at a first draft.

fguisso commented 4 years ago

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?

s-ben commented 4 years ago

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.

jholdstock commented 4 years ago

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

s-ben commented 4 years ago

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