Skip to content

Commit f8ca160

Browse files
jirijakesrustyrussell
authored andcommitted
doc: Remove mentions of 'helpme' plugin
Plugin 'helpme' has been archived, the change removes all mentions of it from documentation. Changelog-None
1 parent 47babbf commit f8ca160

File tree

3 files changed

+1
-32
lines changed

3 files changed

+1
-32
lines changed

README.md

-3
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,6 @@ the lightning network.
106106
There are also numerous plugins available for Core Lightning which add
107107
capabilities: in particular there's a collection at: https://github.com/lightningd/plugins
108108

109-
Including [helpme][helpme-github] which guides you through setting up
110-
your first channels and customizing your node.
111-
112109
For a less reckless experience, you can encrypt the HD wallet seed:
113110
see [HD wallet encryption](#hd-wallet-encryption).
114111

doc/beginners-guide/beginners-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,6 @@ Useful commands:
5757

5858
Once you've started for the first time, there's a script called `contrib/bootstrap-node.sh` which will connect you to other nodes on the lightning network.
5959

60-
There are also numerous plugins available for Core Lightning which add capabilities: see the [Plugins](doc:plugins) guide, and check out the plugin collection at: <https://github.com/lightningd/plugins>, including [helpme](https://github.com/lightningd/plugins/tree/master/helpme) which guides you through setting up your first channels and customising your node.
60+
There are also numerous plugins available for Core Lightning which add capabilities: see the [Plugins](doc:plugins) guide, and check out the plugin collection at: <https://github.com/lightningd/plugins>.
6161

6262
For a less reckless experience, you can encrypt the HD wallet seed: see [HD wallet encryption](doc:backup-and-recovery#hsm-secret-backup).

doc/node-operators-guide/faq.md

-28
Original file line numberDiff line numberDiff line change
@@ -8,34 +8,6 @@ updatedAt: "2023-07-05T09:42:38.017Z"
88
---
99
# General questions
1010

11-
### I don't know where to start, help me !
12-
13-
There is a Core Lightning plugin specifically for this purpose, it's called [`helpme`](https://github.com/lightningd/plugins/tree/master/helpme).
14-
15-
Assuming you have followed the [installation steps](doc:installation), have `lightningd` up and running, and `lightning-cli` in your `$PATH` you can start the plugin like so:
16-
17-
```shell
18-
# Clone the plugins repository
19-
git clone https://github.com/lightningd/plugins
20-
# Make sure the helpme plugin is executable (git should have already handled this)
21-
chmod +x plugins/helpme/helpme.py
22-
# Install its dependencies (there is only one actually)
23-
pip3 install --user -r plugins/helpme/requirements.txt
24-
# Then just start it :)
25-
lightning-cli plugin start $PWD/plugins/helpme/helpme.py
26-
```
27-
28-
29-
30-
The plugin registers a new command `helpme` which will guide you through the main
31-
components of C-lightning:
32-
33-
```shell
34-
lightning-cli helpme
35-
```
36-
37-
38-
3911
### How to get the balance of each channel ?
4012

4113
You can use the `listfunds` command and take a ratio of `our_amount_msat` over

0 commit comments

Comments
 (0)