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

Add Lightning to docs #946

Open
s-ben opened this issue May 22, 2019 · 9 comments
Open

Add Lightning to docs #946

s-ben opened this issue May 22, 2019 · 9 comments
Assignees

Comments

@s-ben
Copy link
Contributor

s-ben commented May 22, 2019

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 s-ben changed the title Add Lightening to docs Add Lightning to docs May 22, 2019
@RichardRed0x
Copy link
Member

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
Copy link
Contributor Author

s-ben commented May 23, 2019

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
Copy link
Member

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
Copy link
Contributor Author

s-ben commented May 23, 2019

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
Copy link
Contributor Author

s-ben commented May 29, 2019

Taking a stab at a first draft.

@jholdstock jholdstock assigned jholdstock and s-ben and unassigned jholdstock May 29, 2019
@fguisso
Copy link
Member

fguisso commented Dec 22, 2019

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
Copy link
Contributor Author

s-ben commented Dec 25, 2019

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
Copy link
Member

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
Copy link
Contributor Author

s-ben commented Jan 9, 2020

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

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

No branches or pull requests

4 participants