lightninglabs / lightninglabs/lnc-web
Document second handshake process in README
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 55
- Forks
- 20
- PR merge metrics
- No merged PRs in 30d
Description
Need to come up with a digestible explanation for this in the README and perhaps for docs.lightning.engineering too
- First connection requires a pairing phrase
- Subsequent connections do not require pairing phrase because the keys will be fetched from storage
- Password is always needed
cc @Liongrass
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the repository README and compare it with the documentation at docs.lightning.engineering. Explain that the first connection uses a pairing phrase, later connections retrieve keys from storage, and a password is always required. Confirm that the second-handshake process is described consistently in the selected documentation locations.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100