lightninglabs / lightninglabs/docs.lightning.engineering
clean up tor documentation
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 73
- Forks
- 73
- Avg merge
- 1h 38m
- Merged PRs (30d)
- 31
Description
At https://docs.lightning.engineering/lightning-network-tools/lnd/quick-tor-setup#create-a-tor-hidden-service we suggest a complicated process to create a hashed password. However, at https://docs.lightning.engineering/lightning-network-tools/lnd/configuring_tor#authentication the easier cookie authentication is mentioned and the setup for that is done at https://docs.lightning.engineering/lightning-network-tools/lnd/configuring_tor#getting-started . Generally, there seem to be a lot of redundant information in both the "Quick Tor Setup" and "Configuring Tor" and it seems like "Quick Tor Setup" is not as easy as "Configuring Tor".
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
Compare the “Quick Tor Setup” and “Configuring Tor” pages, especially the linked sections on hashed-password and cookie authentication setup. Identify redundant instructions and simplify the quick setup using the clearer existing guidance; done means both pages are consistent and no longer duplicate confusing setup steps.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 40/100