From 0f7538a21ecc924810e5398c469da35ea933a989 Mon Sep 17 00:00:00 2001 From: ShahanaFarooqui Date: Wed, 12 Nov 2025 14:26:34 -0800 Subject: [PATCH 1/7] docs: Updated `getting-started` docs for v10 --- doc/getting-started/advanced-setup.md | 10 +++++----- .../advanced-setup/bitcoin-core.md | 9 ++++----- doc/getting-started/advanced-setup/repro.md | 11 +++++------ doc/getting-started/advanced-setup/tor.md | 11 +++++------ doc/getting-started/getting-started.md | 16 +++++++++------- .../getting-started/configuration.md | 12 ++++++------ .../getting-started/hardware-considerations.md | 16 +++++++++------- .../getting-started/installation.md | 13 +++++++------ doc/getting-started/home.md | 15 ++++++++------- doc/getting-started/upgrade.md | 14 +++++++------- 10 files changed, 65 insertions(+), 62 deletions(-) diff --git a/doc/getting-started/advanced-setup.md b/doc/getting-started/advanced-setup.md index ccd68aa1cf03..a811c54785b3 100644 --- a/doc/getting-started/advanced-setup.md +++ b/doc/getting-started/advanced-setup.md @@ -1,7 +1,7 @@ --- -title: "Advanced setup" -slug: "advanced-setup" -hidden: false -createdAt: "2023-01-25T10:54:00.674Z" -updatedAt: "2023-01-25T10:55:28.187Z" +title: Advanced setup +slug: advanced-setup +privacy: + view: public --- + diff --git a/doc/getting-started/advanced-setup/bitcoin-core.md b/doc/getting-started/advanced-setup/bitcoin-core.md index 657c4a27bdd7..588b4258f688 100644 --- a/doc/getting-started/advanced-setup/bitcoin-core.md +++ b/doc/getting-started/advanced-setup/bitcoin-core.md @@ -1,9 +1,8 @@ --- -title: "Bitcoin Core" -slug: "bitcoin-core" -hidden: false -createdAt: "2023-01-31T13:24:19.300Z" -updatedAt: "2023-02-21T13:30:53.906Z" +title: Bitcoin Core +slug: bitcoin-core +privacy: + view: public --- # Using a pruned Bitcoin Core node diff --git a/doc/getting-started/advanced-setup/repro.md b/doc/getting-started/advanced-setup/repro.md index fbf2f954c0f7..971835ca3618 100644 --- a/doc/getting-started/advanced-setup/repro.md +++ b/doc/getting-started/advanced-setup/repro.md @@ -1,9 +1,8 @@ --- -title: "Reproducible builds" -slug: "repro" -hidden: false -createdAt: "2023-01-25T10:37:03.476Z" -updatedAt: "2023-07-12T13:26:52.005Z" +title: Reproducible builds +slug: repro +privacy: + view: public --- [Reproducible builds](https://reproducible-builds.org/) close the final gap in the lifecycle of open-source projects by allowing anyone to verify that a given binary was produced by compiling publicly available source code. @@ -214,4 +213,4 @@ Notice that the two files we downloaded are marked as `OK`, but we're missing on sha256sum: WARNING: 1 computed checksum did NOT match ``` -If both the signature verification and the manifest checksum verification succeeded, then you have just successfully verified a reproducible build and, assuming you trust the maintainers, are good to install and use the binaries. Congratulations! 🎉🥳 \ No newline at end of file +If both the signature verification and the manifest checksum verification succeeded, then you have just successfully verified a reproducible build and, assuming you trust the maintainers, are good to install and use the binaries. Congratulations! 🎉🥳 diff --git a/doc/getting-started/advanced-setup/tor.md b/doc/getting-started/advanced-setup/tor.md index a4d8ef85bf5e..65af41bef316 100644 --- a/doc/getting-started/advanced-setup/tor.md +++ b/doc/getting-started/advanced-setup/tor.md @@ -1,9 +1,8 @@ --- -title: "Using Tor" -slug: "tor" -hidden: false -createdAt: "2023-01-25T10:55:50.059Z" -updatedAt: "2023-02-21T13:30:33.294Z" +title: Using Tor +slug: tor +privacy: + view: public --- To use any Tor features with Core Lightning you must have Tor installed and running. @@ -396,4 +395,4 @@ always-use-proxy=true - [The Tor project](https://www.torproject.org/) - [Tor FAQ](https://www.torproject.org/docs/faq.html.en#WhatIsTor) - [Tor Hidden Service](https://www.torproject.org/docs/onion-services.html.en) -- [.onion addresses version 3](https://blog.torproject.org/we-want-you-test-next-gen-onion-services) \ No newline at end of file +- [.onion addresses version 3](https://blog.torproject.org/we-want-you-test-next-gen-onion-services) diff --git a/doc/getting-started/getting-started.md b/doc/getting-started/getting-started.md index 0faa8f1bbf84..a886105a8741 100644 --- a/doc/getting-started/getting-started.md +++ b/doc/getting-started/getting-started.md @@ -1,10 +1,12 @@ --- -title: "Set up your node" -slug: "getting-started" -excerpt: "This guide will help you set up a Core Lightning node. You'll be up and running in a jiffy!" -hidden: false -createdAt: "2022-11-07T15:26:37.081Z" -updatedAt: "2023-02-22T06:00:15.160Z" +title: Set up your node +slug: getting-started +content: + excerpt: >- + This guide will help you set up a Core Lightning node. You'll be up and + running in a jiffy! +privacy: + view: public --- The Core Lightning implementation has been in production use on the Bitcoin mainnet since early 2018, with the launch of the [Blockstream Store](https://blockstream.com/2018/01/16/en-lightning-charge/). We recommend getting started by experimenting on `testnet` (or `regtest`), but the implementation is considered stable and can be safely used on mainnet. @@ -30,4 +32,4 @@ The following steps will get you up and running with Core Lightning: ## 3. [Configure your node](doc:configuration) as per your requirements (_optional_) -## 4. **[Run your node](doc:beginners-guide)** \ No newline at end of file +## 4. **[Run your node](doc:beginners-guide)** diff --git a/doc/getting-started/getting-started/configuration.md b/doc/getting-started/getting-started/configuration.md index d527d9adbe2c..a2420264da09 100644 --- a/doc/getting-started/getting-started/configuration.md +++ b/doc/getting-started/getting-started/configuration.md @@ -1,10 +1,10 @@ --- -title: "Configuring your node" -slug: "configuration" -excerpt: "Choose from a variety of configuration options as per your needs." -hidden: false -createdAt: "2022-11-18T14:32:13.821Z" -updatedAt: "2023-02-21T13:26:18.280Z" +title: Configuring your node +slug: configuration +content: + excerpt: Choose from a variety of configuration options as per your needs. +privacy: + view: public --- `lightningd` can be configured either by passing options via the command line, or via a configuration file. diff --git a/doc/getting-started/getting-started/hardware-considerations.md b/doc/getting-started/getting-started/hardware-considerations.md index 0d32a7e0b685..8805a5024d08 100644 --- a/doc/getting-started/getting-started/hardware-considerations.md +++ b/doc/getting-started/getting-started/hardware-considerations.md @@ -1,10 +1,12 @@ --- -title: "Hardware considerations" -slug: "hardware-considerations" -excerpt: "A lightning node requires reasonable amount of memory and storage. Learn what's suitable for your scenario." -hidden: true -createdAt: "2022-11-18T14:31:38.695Z" -updatedAt: "2023-04-01T00:09:20.148Z" +title: Hardware considerations +slug: hardware-considerations +content: + excerpt: >- + A lightning node requires reasonable amount of memory and storage. + Learn what's suitable for your scenario. +privacy: + view: anyone_with_link --- # Hobbyist @@ -40,4 +42,4 @@ A checksumming filesystem, such as BTRFS or ZFS, compliments ECC memory by compu Despite the data resiliency assurances we gain using ECC memory, storage mirroring, and filesystem-level checksumming, a Lightning node is still subject to other events such as fires or floods that could compromise the integrity of the node's data. Because of this, it's important to have offsite -# Commercial Grade(?) \ No newline at end of file +# Commercial Grade(?) diff --git a/doc/getting-started/getting-started/installation.md b/doc/getting-started/getting-started/installation.md index 59a19c57e533..6bfa50e32fef 100644 --- a/doc/getting-started/getting-started/installation.md +++ b/doc/getting-started/getting-started/installation.md @@ -1,10 +1,11 @@ --- -title: "Installation" -slug: "installation" -excerpt: "Core lightning is available on many platforms and environments. Learn how to install on your preferred platform." -hidden: false -createdAt: "2022-11-18T14:32:02.251Z" -updatedAt: "2023-07-13T05:08:44.966Z" +title: Installation +slug: installation +content: + excerpt: >- + Core lightning is available on many platforms and environments. Learn how to install on your preferred platform. +privacy: + view: public --- # Binaries diff --git a/doc/getting-started/home.md b/doc/getting-started/home.md index 5e9c99f0ad67..d245c35a0245 100644 --- a/doc/getting-started/home.md +++ b/doc/getting-started/home.md @@ -1,10 +1,11 @@ --- -title: "Welcome to Core Lightning Documentation Portal" -slug: "home" -excerpt: "Here you can find everything you need to jump-start your journey to running and building on Core Lightning." -hidden: false -createdAt: "2023-01-30T15:53:40.926Z" -updatedAt: "2023-02-13T15:43:05.463Z" +title: Welcome to Core Lightning Documentation Portal +slug: home +content: + excerpt: >- + Here you can find everything you need to jump-start your journey to running and building on Core Lightning. +privacy: + view: public --- > 📘 Help us improve! > @@ -18,4 +19,4 @@ updatedAt: "2023-02-13T15:43:05.463Z" { "html": "
\n \t

\n

\n

Getting Started

\n
\n \n \n \n \n \n

Installation

\n

Core lightning is available on many platforms and environments. Learn how to install on your preferred platform.

\n \n \n \n \n \n

Configure your node

\n

Choose from a variety of configuration options as per your needs.

\n \n \n \n \n \n

Upgrade your node

\n

Upgrade to the latest stable releases without interruption.

\n \n \n \n \n \n

Beginner's guide

\n

A guide to all the basics you need to get up and running immediately.

\n \n
\n

For Node Operators

\n
\n \n \n \n \n \n

Analytics

\n

Analyse your node data for effective node management.

\n \n \n \n \n \n

Plugins

\n

Leverage a plethora of plugins on Core Lightning.

\n \n \n \n \n \n

Troubleshooting & FAQ

\n

Common issues and frequently asked questions on operating a CLN node.

\n \n
\n

For Developers

\n
\n \n \n \n \n

Setting up a dev environment

\n

Get up and running in your local environment with essential tools and libraries in your preferred programming language.

\n \n \n \n \n \n

App Development

\n

Build a lightning app using Core Lightning APIs.

\n \n \n \n \n \n

Plugin Development

\n

Customise your Core Lightning node by leveraging its powerful modular architecture via plugins.

\n \n \n \n \n \n

Recipes

\n

Explore working recipes for common use cases.

\n \n \n \n \n \n

API Reference

\n

View all API methods, attributes and responses.

\n \n
\n

For Contributors

\n
\n \n \n \n \n

CLN Architecture

\n

Familiarise yourself with the core components of Core Lightning.

\n \n \n \n \n \n

Contributor Workflow

\n

Learn the practical process and guidelines for contributing.

\n \n \n \n \n \n

Testing

\n

Understand the testing and code review practices.

\n \n \n \n \n \n

Security policy

\n

Learn how to responsibly report a security issue.

\n \n
\n
" } -[/block] \ No newline at end of file +[/block] diff --git a/doc/getting-started/upgrade.md b/doc/getting-started/upgrade.md index 098fac1fdb8f..64dca983b1e4 100644 --- a/doc/getting-started/upgrade.md +++ b/doc/getting-started/upgrade.md @@ -1,10 +1,10 @@ --- -title: "Upgrade" -slug: "upgrade" -excerpt: "Upgrade to the latest stable releases without interruption." -hidden: false -createdAt: "2022-11-18T14:32:58.821Z" -updatedAt: "2023-01-25T10:54:43.810Z" +title: Upgrade +slug: upgrade +content: + excerpt: Upgrade to the latest stable releases without interruption. +privacy: + view: public --- Upgrading your Core Lightning node is the same as installing it. So if you previously installed it using a release binary, download the latest binary in the same directory as before. If you previously built it from the source, fetch the latest source and build it again. @@ -12,4 +12,4 @@ Upgrading your Core Lightning node is the same as installing it. So if you previ > > Upgrades to Core Lightning often change the database: once this is done, downgrades are not generally possible. By default, Core Lightning will exit with an error rather than upgrade, unless this is an official released version. > -> If you really want to upgrade to a non-release version, you can set `database-upgrade=true` in your configuration file, or start `lightningd` with `--database-upgrade=true`(or set to false to never allow a non-reversible upgrade!) \ No newline at end of file +> If you really want to upgrade to a non-release version, you can set `database-upgrade=true` in your configuration file, or start `lightningd` with `--database-upgrade=true`(or set to false to never allow a non-reversible upgrade!) From 2229d7c30ce368f0b119e0e1243c1e255622d1b4 Mon Sep 17 00:00:00 2001 From: ShahanaFarooqui Date: Wed, 12 Nov 2025 14:28:23 -0800 Subject: [PATCH 2/7] docs: Updated `beginners-guide` docs for v10 --- .../backup-and-recovery/advanced-db-backup.md | 10 ++++++---- .../backup-and-recovery/hsm-secret.md | 10 ++++++---- .../backup-and-recovery/recovery.md | 10 ++++++---- doc/beginners-guide/backup.md | 12 ++++++------ doc/beginners-guide/beginners-guide.md | 12 ++++++------ doc/beginners-guide/opening-channels.md | 11 +++++------ .../sending-and-receiving-payments.md | 11 +++++------ doc/beginners-guide/watchtowers.md | 14 +++++++------- 8 files changed, 47 insertions(+), 43 deletions(-) diff --git a/doc/beginners-guide/backup-and-recovery/advanced-db-backup.md b/doc/beginners-guide/backup-and-recovery/advanced-db-backup.md index 900c6276348f..c8ee49ddd9e9 100644 --- a/doc/beginners-guide/backup-and-recovery/advanced-db-backup.md +++ b/doc/beginners-guide/backup-and-recovery/advanced-db-backup.md @@ -1,8 +1,10 @@ --- -title: "Advanced DB Backup" -slug: "advanced-db-backup" -excerpt: "Learn the various DB backup techniques." -hidden: false +title: Advanced DB Backup +slug: advanced-db-backup +content: + excerpt: Learn the various DB backup techniques. +privacy: + view: public --- To recover in-channel funds, you need to use one or more of the backup strategies below. diff --git a/doc/beginners-guide/backup-and-recovery/hsm-secret.md b/doc/beginners-guide/backup-and-recovery/hsm-secret.md index 59be59611ca0..e1fa3a02b569 100644 --- a/doc/beginners-guide/backup-and-recovery/hsm-secret.md +++ b/doc/beginners-guide/backup-and-recovery/hsm-secret.md @@ -1,8 +1,10 @@ --- -title: "HSM Secret" -slug: "hsm-secret" -excerpt: "Learn about various cool HSM secret methods." -hidden: false +title: HSM Secret +slug: hsm-secret +content: + excerpt: Learn about various cool HSM secret methods. +privacy: + view: public --- diff --git a/doc/beginners-guide/backup-and-recovery/recovery.md b/doc/beginners-guide/backup-and-recovery/recovery.md index 5e8def0b038e..34b55e7bac16 100644 --- a/doc/beginners-guide/backup-and-recovery/recovery.md +++ b/doc/beginners-guide/backup-and-recovery/recovery.md @@ -1,8 +1,10 @@ --- -title: "Wallet recovery" -slug: "recovery" -excerpt: "Learn about various recovery methods." -hidden: false +title: Wallet recovery +slug: recovery +content: + excerpt: Learn about various recovery methods. +privacy: + view: public --- diff --git a/doc/beginners-guide/backup.md b/doc/beginners-guide/backup.md index a8413a96c749..dc31df168c97 100644 --- a/doc/beginners-guide/backup.md +++ b/doc/beginners-guide/backup.md @@ -1,10 +1,10 @@ --- -title: "Backup your wallet" -slug: "backup" -excerpt: "Learn the various backup options available for your Core Lightning node." -hidden: false -createdAt: "2022-11-18T16:28:17.292Z" -updatedAt: "2023-04-22T12:51:49.775Z" +title: Backup your wallet +slug: backup +content: + excerpt: Learn the various backup options available for your Core Lightning node. +privacy: + view: public --- In Lightning, since _you_ are the only one storing all your financial information, you **_cannot_** recover this financial information from anywhere else.This means that on Lightning, **you have to** responsibly back up your financial information yourself, using various processes and automation. diff --git a/doc/beginners-guide/beginners-guide.md b/doc/beginners-guide/beginners-guide.md index cae17de7d1df..3aaff13a5e72 100644 --- a/doc/beginners-guide/beginners-guide.md +++ b/doc/beginners-guide/beginners-guide.md @@ -1,10 +1,10 @@ --- -title: "Running your node" -slug: "beginners-guide" -excerpt: "A guide to all the basics you need to get up and running immediately." -hidden: false -createdAt: "2022-11-18T14:27:50.098Z" -updatedAt: "2023-02-21T13:49:20.132Z" +title: Running your node +slug: beginners-guide +content: + excerpt: A guide to all the basics you need to get up and running immediately. +privacy: + view: public --- ## Starting `lightningd` diff --git a/doc/beginners-guide/opening-channels.md b/doc/beginners-guide/opening-channels.md index 8c7b87b361c4..2d7800a6ac07 100644 --- a/doc/beginners-guide/opening-channels.md +++ b/doc/beginners-guide/opening-channels.md @@ -1,9 +1,8 @@ --- -title: "Opening channels" -slug: "opening-channels" -hidden: false -createdAt: "2022-11-18T16:26:57.798Z" -updatedAt: "2023-01-31T15:07:08.196Z" +title: Opening channels +slug: opening-channels +privacy: + view: public --- First you need to transfer some funds to `lightningd` so that it can open a channel: @@ -47,4 +46,4 @@ This opens a connection and, on top of that connection, then opens a channel. The funding transaction needs 3 confirmations in order for the channel to be usable, and 6 to be announced for others to use. -You can check the status of the channel using `lightning-cli listpeers`, which after 3 confirmations (1 on testnet) should say that `state` is `CHANNELD_NORMAL`; after 6 confirmations you can use `lightning-cli listchannels` to verify that the `public` field is now `true`. \ No newline at end of file +You can check the status of the channel using `lightning-cli listpeers`, which after 3 confirmations (1 on testnet) should say that `state` is `CHANNELD_NORMAL`; after 6 confirmations you can use `lightning-cli listchannels` to verify that the `public` field is now `true`. diff --git a/doc/beginners-guide/sending-and-receiving-payments.md b/doc/beginners-guide/sending-and-receiving-payments.md index cbc757218705..d354d05c7389 100644 --- a/doc/beginners-guide/sending-and-receiving-payments.md +++ b/doc/beginners-guide/sending-and-receiving-payments.md @@ -1,9 +1,8 @@ --- -title: "Sending and receiving payments" -slug: "sending-and-receiving-payments" -hidden: false -createdAt: "2022-11-18T16:27:07.625Z" -updatedAt: "2023-01-31T15:06:02.214Z" +title: Sending and receiving payments +slug: sending-and-receiving-payments +privacy: + view: public --- Payments in Lightning are invoice based. @@ -21,4 +20,4 @@ The sender can feed this `bolt11` string to the `decodepay` command to see what lightning-cli pay ``` -Note that there are lower-level interfaces (and more options to these interfaces) for more sophisticated use. \ No newline at end of file +Note that there are lower-level interfaces (and more options to these interfaces) for more sophisticated use. diff --git a/doc/beginners-guide/watchtowers.md b/doc/beginners-guide/watchtowers.md index 527694b4bf78..f577ec715b45 100644 --- a/doc/beginners-guide/watchtowers.md +++ b/doc/beginners-guide/watchtowers.md @@ -1,13 +1,13 @@ --- -title: "Watchtowers" -slug: "watchtowers" -excerpt: "Defend your node against breaches using a watchtower." -hidden: false -createdAt: "2022-11-18T16:28:27.054Z" -updatedAt: "2023-02-02T07:13:57.111Z" +title: Watchtowers +slug: watchtowers +content: + excerpt: Defend your node against breaches using a watchtower. +privacy: + view: public --- The Lightning Network protocol assumes that a node is always online and synchronised with the network. Should your lightning node go offline for some time, it is possible that a node on the other side of your channel may attempt to force close the channel with an outdated state (also known as revoked commitment). This may allow them to steal funds from the channel that belonged to you. A watchtower is a third-party service that you can hire to defend your node against such breaches, whether malicious or accidental, in the event that your node goes offline. It will watch for breaches on the blockchain and punish the malicious peer by relaying a penalty transaction on your behalf. -There are a number of watchtower services available today. One of them is the [watchtower client plugin](https://github.com/talaia-labs/rust-teos/tree/master/watchtower-plugin) that works with the [Eye of Satoshi tower](https://github.com/talaia-labs/rust-teos) (or any [BOLT13](https://github.com/sr-gi/bolt13/blob/master/13-watchtowers.md) compliant watchtower). \ No newline at end of file +There are a number of watchtower services available today. One of them is the [watchtower client plugin](https://github.com/talaia-labs/rust-teos/tree/master/watchtower-plugin) that works with the [Eye of Satoshi tower](https://github.com/talaia-labs/rust-teos) (or any [BOLT13](https://github.com/sr-gi/bolt13/blob/master/13-watchtowers.md) compliant watchtower). From 326056c0764ab29cf298b9ef220cf05ba7eda403 Mon Sep 17 00:00:00 2001 From: ShahanaFarooqui Date: Wed, 12 Nov 2025 14:30:09 -0800 Subject: [PATCH 3/7] docs: Updated `node-operators-guide` docs for v10 --- doc/node-operators-guide/analytics.md | 12 ++++++------ doc/node-operators-guide/channel-management.md | 14 ++++++++------ doc/node-operators-guide/faq.md | 12 ++++++------ doc/node-operators-guide/plugins.md | 14 +++++++------- 4 files changed, 27 insertions(+), 25 deletions(-) diff --git a/doc/node-operators-guide/analytics.md b/doc/node-operators-guide/analytics.md index d269de421363..d58923883c7e 100644 --- a/doc/node-operators-guide/analytics.md +++ b/doc/node-operators-guide/analytics.md @@ -1,10 +1,10 @@ --- -title: "Analytics" -slug: "analytics" -excerpt: "Analyse your node data for effective node management." -hidden: false -createdAt: "2022-12-09T09:54:38.377Z" -updatedAt: "2023-02-21T13:39:32.669Z" +title: Analytics +slug: analytics +content: + excerpt: Analyse your node data for effective node management. +privacy: + view: public --- ## Using SQL plugin diff --git a/doc/node-operators-guide/channel-management.md b/doc/node-operators-guide/channel-management.md index 33b7a15d7898..4104ef167b89 100644 --- a/doc/node-operators-guide/channel-management.md +++ b/doc/node-operators-guide/channel-management.md @@ -1,8 +1,10 @@ --- -title: "Channel Management" -slug: "channel-management" -excerpt: "Manage your channels and liquidity effectively and efficiently with careful planning and active monitoring." -hidden: true -createdAt: "2022-11-18T14:28:10.211Z" -updatedAt: "2023-02-08T15:10:28.588Z" +title: Channel Management +slug: channel-management +content: + excerpt: >- + Manage your channels and liquidity effectively and efficiently with careful planning and active monitoring. +privacy: + view: anyone_with_link --- + diff --git a/doc/node-operators-guide/faq.md b/doc/node-operators-guide/faq.md index de7c479a03bc..aaf8c23d4202 100644 --- a/doc/node-operators-guide/faq.md +++ b/doc/node-operators-guide/faq.md @@ -1,10 +1,10 @@ --- -title: "Troubleshooting & FAQ" -slug: "faq" -excerpt: "Common issues and frequently asked questions on operating a CLN node." -hidden: false -createdAt: "2023-01-25T13:15:09.290Z" -updatedAt: "2023-07-05T09:42:38.017Z" +title: Troubleshooting & FAQ +slug: faq +content: + excerpt: Common issues and frequently asked questions on operating a CLN node. +privacy: + view: public --- # General questions diff --git a/doc/node-operators-guide/plugins.md b/doc/node-operators-guide/plugins.md index e18d2b351692..be288d921ecc 100644 --- a/doc/node-operators-guide/plugins.md +++ b/doc/node-operators-guide/plugins.md @@ -1,10 +1,10 @@ --- -title: "Plugins" -slug: "plugins" -excerpt: "Leverage a plethora of plugins on Core Lightning." -hidden: false -createdAt: "2022-12-09T09:55:05.629Z" -updatedAt: "2023-02-14T12:47:46.112Z" +title: Plugins +slug: plugins +content: + excerpt: Leverage a plethora of plugins on Core Lightning. +privacy: + view: public --- Power up your Core Lightning node and tailor it for your business needs with community built plugins. @@ -116,4 +116,4 @@ Available option flags: ## Troubleshooting -Plugins must be executable. For python plugins, the shebang is invoked, so **python3** should be available in your environment. This can be verified with **which Python3**. The default reckless directory is $USER/.lightning/reckless and it should be possible for the lightningd user to execute files located here. If this is a problem, the option flag **reckless -d=\** may be used to relocate the reckless directory from its default. Consider creating a permanent alias in this case. \ No newline at end of file +Plugins must be executable. For python plugins, the shebang is invoked, so **python3** should be available in your environment. This can be verified with **which Python3**. The default reckless directory is $USER/.lightning/reckless and it should be possible for the lightningd user to execute files located here. If this is a problem, the option flag **reckless -d=\** may be used to relocate the reckless directory from its default. Consider creating a permanent alias in this case. From 936da9e033691cc3fb320b35c1e22c9eb0e6b3f6 Mon Sep 17 00:00:00 2001 From: ShahanaFarooqui Date: Wed, 12 Nov 2025 14:32:54 -0800 Subject: [PATCH 4/7] docs: Updated `developers-guide` docs for v10 --- doc/developers-guide/api-reference.md | 16 ++++++++-------- doc/developers-guide/app-development.md | 10 ++++++---- .../app-development/commando-plugin.md | 9 ++++----- doc/developers-guide/app-development/grpc.md | 9 ++++----- doc/developers-guide/app-development/json-rpc.md | 9 ++++----- doc/developers-guide/app-development/rest.md | 9 ++++----- .../app-development/third-party-libraries.md | 9 ++++----- .../app-development/wss-proxy.md | 9 ++++----- doc/developers-guide/deprecated-features.md | 10 ++++++---- doc/developers-guide/developers-guide.md | 14 ++++++++------ doc/developers-guide/plugin-development.md | 16 +++++++++------- .../a-day-in-the-life-of-a-plugin.md | 9 ++++----- .../plugin-development/additional-resources.md | 11 +++++------ .../plugin-development/bitcoin-backend.md | 9 ++++----- .../plugin-development/event-notifications.md | 9 ++++----- doc/developers-guide/plugin-development/hooks.md | 9 ++++----- .../plugin-development/json-rpc-passthrough.md | 11 +++++------ .../plugin-development/plugin-manager.md | 14 +++++++------- doc/developers-guide/tracing-cln-performance.md | 7 ++++--- doc/developers-guide/tutorials.md | 16 ++++++++-------- 20 files changed, 106 insertions(+), 109 deletions(-) diff --git a/doc/developers-guide/api-reference.md b/doc/developers-guide/api-reference.md index 931af11bb3eb..5e5af9f0e589 100644 --- a/doc/developers-guide/api-reference.md +++ b/doc/developers-guide/api-reference.md @@ -1,10 +1,10 @@ --- -title: "API Reference" -slug: "api-reference" -excerpt: "View all API methods, attributes and responses." -hidden: false -createdAt: "2022-12-09T09:57:05.023Z" -updatedAt: "2023-01-22T18:11:50.838Z" -type: "link" -link_url: "https://docs.corelightning.org/reference" +title: API Reference +slug: api-reference +type: link +content: + excerpt: 'View all API methods, attributes and responses.' +privacy: + view: public --- + diff --git a/doc/developers-guide/app-development.md b/doc/developers-guide/app-development.md index 57276ed5485c..b2961e5b0061 100644 --- a/doc/developers-guide/app-development.md +++ b/doc/developers-guide/app-development.md @@ -1,8 +1,10 @@ --- -title: "App Development" -slug: "app-development" -excerpt: "Build a lightning application using Core Lightning APIs." -hidden: false +title: App Development +slug: app-development +content: + excerpt: Build a lightning application using Core Lightning APIs. +privacy: + view: public --- ## Interacting with CLN Node diff --git a/doc/developers-guide/app-development/commando-plugin.md b/doc/developers-guide/app-development/commando-plugin.md index eecf16a04644..3163fc8d9cd3 100644 --- a/doc/developers-guide/app-development/commando-plugin.md +++ b/doc/developers-guide/app-development/commando-plugin.md @@ -1,9 +1,8 @@ --- -title: "Commando Plugin" -slug: "commando-plugin" -hidden: false -createdAt: "2023-02-08T09:54:01.784Z" -updatedAt: "2023-09-05T13:55:16.224Z" +title: Commando Plugin +slug: commando-plugin +privacy: + view: public --- > 📘 > diff --git a/doc/developers-guide/app-development/grpc.md b/doc/developers-guide/app-development/grpc.md index 50f5345a5c82..55c8725052de 100644 --- a/doc/developers-guide/app-development/grpc.md +++ b/doc/developers-guide/app-development/grpc.md @@ -1,9 +1,8 @@ --- -title: "gRPC APIs" -slug: "grpc" -hidden: false -createdAt: "2023-02-07T12:52:39.665Z" -updatedAt: "2023-02-08T09:56:41.158Z" +title: gRPC APIs +slug: grpc +privacy: + view: public --- > 📘 > diff --git a/doc/developers-guide/app-development/json-rpc.md b/doc/developers-guide/app-development/json-rpc.md index f140f046a539..44fee8bee7fc 100644 --- a/doc/developers-guide/app-development/json-rpc.md +++ b/doc/developers-guide/app-development/json-rpc.md @@ -1,9 +1,8 @@ --- -title: "JSON-RPC commands" -slug: "json-rpc" -hidden: false -createdAt: "2023-02-07T12:53:11.917Z" -updatedAt: "2023-02-21T13:50:10.086Z" +title: JSON-RPC commands +slug: json-rpc +privacy: + view: public --- > 📘 > diff --git a/doc/developers-guide/app-development/rest.md b/doc/developers-guide/app-development/rest.md index 501439366dce..a71fadce280c 100644 --- a/doc/developers-guide/app-development/rest.md +++ b/doc/developers-guide/app-development/rest.md @@ -1,9 +1,8 @@ --- -title: "REST APIs" -slug: "rest" -hidden: false -createdAt: "2023-09-05T09:54:01.784Z" -updatedAt: "2023-10-13T09:54:01.784Z" +title: REST APIs +slug: rest +privacy: + view: public --- # CLNRest diff --git a/doc/developers-guide/app-development/third-party-libraries.md b/doc/developers-guide/app-development/third-party-libraries.md index 519a1b60b3d0..e8602613d12a 100644 --- a/doc/developers-guide/app-development/third-party-libraries.md +++ b/doc/developers-guide/app-development/third-party-libraries.md @@ -1,9 +1,8 @@ --- -title: "Third-party libraries" -slug: "third-party-libraries" -hidden: false -createdAt: "2023-02-08T09:54:01.784Z" -updatedAt: "2023-09-05T13:55:16.224Z" +title: Third-party libraries +slug: third-party-libraries +privacy: + view: public --- ## GraphQL diff --git a/doc/developers-guide/app-development/wss-proxy.md b/doc/developers-guide/app-development/wss-proxy.md index 00b75dfc16b2..43c3b0530fd6 100644 --- a/doc/developers-guide/app-development/wss-proxy.md +++ b/doc/developers-guide/app-development/wss-proxy.md @@ -1,9 +1,8 @@ --- -title: "WSS Proxy" -slug: "wss-proxy" -hidden: false -createdAt: "2024-04-15T09:54:01.784Z" -updatedAt: "2024-04-15T09:54:01.784Z" +title: WSS Proxy +slug: wss-proxy +privacy: + view: public --- # WSS-Proxy diff --git a/doc/developers-guide/deprecated-features.md b/doc/developers-guide/deprecated-features.md index 4acd298f87bd..c70392217415 100644 --- a/doc/developers-guide/deprecated-features.md +++ b/doc/developers-guide/deprecated-features.md @@ -1,8 +1,10 @@ --- -title: "Deprecated Features" -slug: "deprecated-features" -excerpt: "Deprecated features and timeline for old feature removals." -hidden: false +title: Deprecated Features +slug: deprecated-features +content: + excerpt: Deprecated features and timeline for old feature removals. +privacy: + view: public --- | Name | Type | First Deprecated | Last Supported | Description | diff --git a/doc/developers-guide/developers-guide.md b/doc/developers-guide/developers-guide.md index d86ba08b3241..726bd530b060 100644 --- a/doc/developers-guide/developers-guide.md +++ b/doc/developers-guide/developers-guide.md @@ -1,10 +1,12 @@ --- -title: "Setting up a dev environment" -slug: "developers-guide" -excerpt: "Get up and running in your local environment with essential tools and libraries in your preferred programming language." -hidden: false -createdAt: "2022-11-18T14:28:23.407Z" -updatedAt: "2023-02-08T11:42:44.759Z" +title: Setting up a dev environment +slug: developers-guide +content: + excerpt: >- + Get up and running in your local environment with essential tools and + libraries in your preferred programming language. +privacy: + view: public --- ## Using `startup_regtest.sh` diff --git a/doc/developers-guide/plugin-development.md b/doc/developers-guide/plugin-development.md index a9208a485f71..e3b04b19abef 100644 --- a/doc/developers-guide/plugin-development.md +++ b/doc/developers-guide/plugin-development.md @@ -1,14 +1,16 @@ --- -title: "Plugin Development" -slug: "plugin-development" -excerpt: "Customise your Core Lightning node by leveraging its powerful modular architecture via plugins." -hidden: false -createdAt: "2022-12-09T09:56:22.085Z" -updatedAt: "2023-02-06T03:21:36.614Z" +title: Plugin Development +slug: plugin-development +content: + excerpt: >- + Customise your Core Lightning node by leveraging its powerful modular + architecture via plugins. +privacy: + view: public --- Plugins are a simple yet powerful way to extend the functionality provided by Core Lightning. They are subprocesses that are started by the main `lightningd` daemon and can interact with `lightningd` in a variety of ways: - **[Command line option passthrough](doc:a-day-in-the-life-of-a-plugin)** allows plugins to register their own command line options that are exposed through `lightningd` so that only the main process needs to be configured. Option values are not remembered when a plugin is stopped or killed, but can be passed as parameters to [`plugin start`][lightning-plugin]. - **[JSON-RPC command passthrough](doc:json-rpc-passthrough)** adds a way for plugins to add their own commands to the JSON-RPC interface. - **[Event stream subscriptions](doc:event-notifications)** provide plugins with a push-based notification mechanism about events from the `lightningd`. -- **[Hooks](doc:hooks)** are a primitive that allows plugins to be notified about internal events in `lightningd` and alter its behavior or inject custom behaviors. \ No newline at end of file +- **[Hooks](doc:hooks)** are a primitive that allows plugins to be notified about internal events in `lightningd` and alter its behavior or inject custom behaviors. diff --git a/doc/developers-guide/plugin-development/a-day-in-the-life-of-a-plugin.md b/doc/developers-guide/plugin-development/a-day-in-the-life-of-a-plugin.md index 41c817c9ede0..5d9c14f4164b 100644 --- a/doc/developers-guide/plugin-development/a-day-in-the-life-of-a-plugin.md +++ b/doc/developers-guide/plugin-development/a-day-in-the-life-of-a-plugin.md @@ -1,9 +1,8 @@ --- -title: "A day in the life of a plugin" -slug: "a-day-in-the-life-of-a-plugin" -hidden: false -createdAt: "2023-02-03T08:32:53.431Z" -updatedAt: "2023-07-12T13:48:23.030Z" +title: A day in the life of a plugin +slug: a-day-in-the-life-of-a-plugin +privacy: + view: public --- A plugin may be written in any language, and communicates with `lightningd` through the plugin's `stdin` and `stdout`. JSON-RPCv2 is used as protocol on top of the two streams, with the plugin acting as server and `lightningd` acting as client. The plugin file needs to be executable (e.g. use `chmod a+x plugin_name`). diff --git a/doc/developers-guide/plugin-development/additional-resources.md b/doc/developers-guide/plugin-development/additional-resources.md index 045c9506ee8a..97b78653db82 100644 --- a/doc/developers-guide/plugin-development/additional-resources.md +++ b/doc/developers-guide/plugin-development/additional-resources.md @@ -1,9 +1,8 @@ --- -title: "Tutorials" -slug: "additional-resources" -hidden: false -createdAt: "2023-02-03T08:33:51.998Z" -updatedAt: "2023-02-08T09:36:57.988Z" +title: Tutorials +slug: additional-resources +privacy: + view: public --- ## Writing a plugin in Python @@ -51,4 +50,4 @@ Finally, `lightningd`'s own internal [tests](https://github.com/ElementsProject/ ## Community built plugins -Check out this [repository](https://github.com/lightningd/plugins#plugin-builder-resources) that has a collection of actively maintained plugins as well as plugin libraries (in your favourite language) built by the community. \ No newline at end of file +Check out this [repository](https://github.com/lightningd/plugins#plugin-builder-resources) that has a collection of actively maintained plugins as well as plugin libraries (in your favourite language) built by the community. diff --git a/doc/developers-guide/plugin-development/bitcoin-backend.md b/doc/developers-guide/plugin-development/bitcoin-backend.md index 4dce580e28b8..997807a6e8ab 100644 --- a/doc/developers-guide/plugin-development/bitcoin-backend.md +++ b/doc/developers-guide/plugin-development/bitcoin-backend.md @@ -1,9 +1,8 @@ --- -title: "Bitcoin backend" -slug: "bitcoin-backend" -hidden: false -createdAt: "2023-02-03T08:58:27.125Z" -updatedAt: "2023-07-13T05:18:59.439Z" +title: Bitcoin backend +slug: bitcoin-backend +privacy: + view: public --- Core Lightning communicates with the Bitcoin network through a plugin. It uses the `bcli` plugin by default but you can use a custom one, multiple custom ones for different operations, or write your own for your favourite Bitcoin data source! diff --git a/doc/developers-guide/plugin-development/event-notifications.md b/doc/developers-guide/plugin-development/event-notifications.md index c16c1e834f6a..4ee034a8548d 100644 --- a/doc/developers-guide/plugin-development/event-notifications.md +++ b/doc/developers-guide/plugin-development/event-notifications.md @@ -1,9 +1,8 @@ --- -title: "Event notifications" -slug: "event-notifications" -hidden: false -createdAt: "2023-02-03T08:57:15.799Z" -updatedAt: "2023-07-14T07:17:17.114Z" +title: Event notifications +slug: event-notifications +privacy: + view: public --- Event notifications allow a plugin to subscribe to events in `lightningd`. `lightningd` will then send a push notification if an event matching the subscription occurred. A notification is defined in the JSON-RPC [specification][jsonrpc-spec] as an RPC call that does not include an `id` parameter: diff --git a/doc/developers-guide/plugin-development/hooks.md b/doc/developers-guide/plugin-development/hooks.md index d78abe77870b..ba2c53daa45e 100644 --- a/doc/developers-guide/plugin-development/hooks.md +++ b/doc/developers-guide/plugin-development/hooks.md @@ -1,9 +1,8 @@ --- -title: "Hooks" -slug: "hooks" -hidden: false -createdAt: "2023-02-03T08:57:58.166Z" -updatedAt: "2023-02-21T15:08:30.254Z" +title: Hooks +slug: hooks +privacy: + view: public --- Hooks allow a plugin to define custom behavior for `lightningd` without having to modify the Core Lightning source code itself. A plugin declares that it'd like to be consulted on what to do next for certain events in the daemon. A hook can then decide how `lightningd` should react to the given event. diff --git a/doc/developers-guide/plugin-development/json-rpc-passthrough.md b/doc/developers-guide/plugin-development/json-rpc-passthrough.md index c25244ff429c..a3912074d2e5 100644 --- a/doc/developers-guide/plugin-development/json-rpc-passthrough.md +++ b/doc/developers-guide/plugin-development/json-rpc-passthrough.md @@ -1,9 +1,8 @@ --- -title: "JSON-RPC passthrough" -slug: "json-rpc-passthrough" -hidden: false -createdAt: "2023-02-03T08:53:50.840Z" -updatedAt: "2023-02-03T08:53:50.840Z" +title: JSON-RPC passthrough +slug: json-rpc-passthrough +privacy: + view: public --- Plugins may register their own JSON-RPC methods that are exposed through the JSON-RPC provided by `lightningd`. This provides users with a single interface to interact with, while allowing the addition of custom methods without having to modify the daemon itself. @@ -31,4 +30,4 @@ For example, `getmanifest` result will register two methods, called `hello` and The RPC call will be passed through unmodified, with the exception of the JSON-RPC call `id`, which is internally remapped to a unique integer instead, in order to avoid collisions. When passing the result back the `id` field is restored to its original value. Note that if your `result` for an RPC call includes `"format-hint": -"simple"`, then `lightning-cli` will default to printing your output in "human-readable" flat form. \ No newline at end of file +"simple"`, then `lightning-cli` will default to printing your output in "human-readable" flat form. diff --git a/doc/developers-guide/plugin-development/plugin-manager.md b/doc/developers-guide/plugin-development/plugin-manager.md index ef75f8cdb8c2..4304c1373f71 100644 --- a/doc/developers-guide/plugin-development/plugin-manager.md +++ b/doc/developers-guide/plugin-development/plugin-manager.md @@ -1,10 +1,10 @@ --- -title: "Plugin manager" -slug: "plugin-manager" -excerpt: "Learn how to add your plugin to the `reckless` plugin manager." -hidden: false -createdAt: "2023-02-08T13:22:17.211Z" -updatedAt: "2023-02-21T15:11:45.714Z" +title: Plugin manager +slug: plugin-manager +content: + excerpt: Learn how to add your plugin to the `reckless` plugin manager. +privacy: + view: public --- `reckless` is a plugin manager for Core Lightning that you can use to install and uninstall [plugins](doc:plugins) with a single command. @@ -21,4 +21,4 @@ To make your plugin compatible with reckless install: > > As reckless needs to know how to handle and install the dependencies of a plugin, current version only supports python plugins. We are working on a broader support, e.g., for javascript, golang and other popular programming languages. > -> Stay tuned and tell us what languages you need support for, and what features you're missing. \ No newline at end of file +> Stay tuned and tell us what languages you need support for, and what features you're missing. diff --git a/doc/developers-guide/tracing-cln-performance.md b/doc/developers-guide/tracing-cln-performance.md index e0d40e01ea47..445df81b0ad2 100644 --- a/doc/developers-guide/tracing-cln-performance.md +++ b/doc/developers-guide/tracing-cln-performance.md @@ -1,7 +1,8 @@ --- -title: "Tracing CLN Performance" -slug: "tracing-cln-performance" -hidden: false +title: Tracing CLN Performance +slug: tracing-cln-performance +privacy: + view: public --- CLN includes a simple opentracing exporter that allows tracing the execution of the node in real-time, without incurring a performance penalty when not listening for traces. Quoting the [Wikipedia](https://en.wikipedia.org/wiki/Tracing_(software)) entry on Tracing: diff --git a/doc/developers-guide/tutorials.md b/doc/developers-guide/tutorials.md index 4dcb49fbf262..3b5b3265a734 100644 --- a/doc/developers-guide/tutorials.md +++ b/doc/developers-guide/tutorials.md @@ -1,10 +1,10 @@ --- -title: "Recipes" -slug: "tutorials" -excerpt: "Explore working tutorials for common use cases." -hidden: false -createdAt: "2022-12-09T09:56:46.172Z" -updatedAt: "2023-02-02T13:59:44.679Z" -type: "link" -link_url: "https://docs.corelightning.org/recipes" +title: Recipes +slug: tutorials +type: link +content: + excerpt: Explore working tutorials for common use cases. +privacy: + view: public --- + From 092b52b48bc9aaaaef0712b9b7b77024b0a73197 Mon Sep 17 00:00:00 2001 From: ShahanaFarooqui Date: Wed, 12 Nov 2025 14:34:06 -0800 Subject: [PATCH 5/7] docs: Updated `contribute-to-core-lightning` docs for v10 --- doc/contribute-to-core-lightning/code-generation.md | 9 ++++----- .../coding-style-guidelines.md | 9 ++++----- .../coding-style-guidelines/writing-json-schemas.md | 9 ++++----- .../contribute-to-core-lightning.md | 12 ++++++------ .../contributor-workflow.md | 12 ++++++------ doc/contribute-to-core-lightning/docker-images.md | 11 +++++------ .../release-checklist.md | 9 ++++----- doc/contribute-to-core-lightning/security-policy.md | 12 ++++++------ doc/contribute-to-core-lightning/testing.md | 12 ++++++------ 9 files changed, 45 insertions(+), 50 deletions(-) diff --git a/doc/contribute-to-core-lightning/code-generation.md b/doc/contribute-to-core-lightning/code-generation.md index 58f45c751c87..c58c948703fd 100644 --- a/doc/contribute-to-core-lightning/code-generation.md +++ b/doc/contribute-to-core-lightning/code-generation.md @@ -1,9 +1,8 @@ --- -title: "Code Generation" -slug: "code-generation" -hidden: false -createdAt: "2023-04-22T12:29:01.116Z" -updatedAt: "2024-01-18T12:44:47.814Z" +title: Code Generation +slug: code-generation +privacy: + view: public --- The CLN project has a multitude of interfaces, most of which are generated from an abstract schema: diff --git a/doc/contribute-to-core-lightning/coding-style-guidelines.md b/doc/contribute-to-core-lightning/coding-style-guidelines.md index c9400dc30b75..3b5a04c4fce1 100644 --- a/doc/contribute-to-core-lightning/coding-style-guidelines.md +++ b/doc/contribute-to-core-lightning/coding-style-guidelines.md @@ -1,9 +1,8 @@ --- -title: "Coding Style Guidelines" -slug: "coding-style-guidelines" -hidden: false -createdAt: "2023-01-25T05:34:10.822Z" -updatedAt: "2023-07-13T05:11:09.525Z" +title: Coding Style Guidelines +slug: coding-style-guidelines +privacy: + view: public --- Style is an individualistic thing, but working on software is group activity, so consistency is important. Generally our coding style is similar to the [Linux coding style](https://www.kernel.org/doc/html/v4.10/process/coding-style.html). diff --git a/doc/contribute-to-core-lightning/coding-style-guidelines/writing-json-schemas.md b/doc/contribute-to-core-lightning/coding-style-guidelines/writing-json-schemas.md index d51b714193de..110793183487 100644 --- a/doc/contribute-to-core-lightning/coding-style-guidelines/writing-json-schemas.md +++ b/doc/contribute-to-core-lightning/coding-style-guidelines/writing-json-schemas.md @@ -1,9 +1,8 @@ --- -title: "Writing JSON Schemas" -slug: "writing-json-schemas" -hidden: false -createdAt: "2023-01-25T05:46:43.718Z" -updatedAt: "2024-01-18T15:36:28.523Z" +title: Writing JSON Schemas +slug: writing-json-schemas +privacy: + view: public --- A JSON Schema is a JSON file which defines what a structure should look like; in our case we use it in our testsuite to check that they match command requests and responses, and also use it to generate our documentation. diff --git a/doc/contribute-to-core-lightning/contribute-to-core-lightning.md b/doc/contribute-to-core-lightning/contribute-to-core-lightning.md index 0c5d2320f02f..58eef148f297 100644 --- a/doc/contribute-to-core-lightning/contribute-to-core-lightning.md +++ b/doc/contribute-to-core-lightning/contribute-to-core-lightning.md @@ -1,10 +1,10 @@ --- -title: "CLN Architecture" -slug: "contribute-to-core-lightning" -excerpt: "Familiarise yourself with the core components of Core Lightning." -hidden: false -createdAt: "2022-11-18T14:28:33.564Z" -updatedAt: "2023-02-21T15:12:37.888Z" +title: CLN Architecture +slug: contribute-to-core-lightning +content: + excerpt: Familiarise yourself with the core components of Core Lightning. +privacy: + view: public --- The Core Lightning project implements the lightning protocol as specified in [various BOLTs](https://github.com/lightning/bolts). It's broken into subdaemons, with the idea being that we can add more layers of separation between different clients and extra barriers to exploits. diff --git a/doc/contribute-to-core-lightning/contributor-workflow.md b/doc/contribute-to-core-lightning/contributor-workflow.md index 1d59f9de8907..e4ba0d614324 100644 --- a/doc/contribute-to-core-lightning/contributor-workflow.md +++ b/doc/contribute-to-core-lightning/contributor-workflow.md @@ -1,10 +1,10 @@ --- -title: "Contributor Workflow" -slug: "contributor-workflow" -excerpt: "Learn the practical process and guidelines for contributing." -hidden: false -createdAt: "2022-12-09T09:57:57.245Z" -updatedAt: "2023-07-12T13:40:58.465Z" +title: Contributor Workflow +slug: contributor-workflow +content: + excerpt: Learn the practical process and guidelines for contributing. +privacy: + view: public --- ## Build and Development diff --git a/doc/contribute-to-core-lightning/docker-images.md b/doc/contribute-to-core-lightning/docker-images.md index 0e15493640e3..476b8f1348eb 100644 --- a/doc/contribute-to-core-lightning/docker-images.md +++ b/doc/contribute-to-core-lightning/docker-images.md @@ -1,9 +1,8 @@ --- -title: "Docker Images" -slug: "docker-images" -hidden: false -createdAt: "2023-12-07T10:00:00.000Z" -updatedAt: "2023-12-07T10:00:00.000Z" +title: Docker Images +slug: docker-images +privacy: + view: public --- # Setting up Docker's Buildx @@ -131,4 +130,4 @@ docker exec -it bash ```shell docker run -it --rm --platform=linux/amd64 --network=host -v '/root/.lightning:/root/.lightning' -v '/root/.bitcoin:/root/.bitcoin' -e LIGHTNINGD_DATA=/root/.lightning elementsproject/lightningd:latest --network=regtest -``` \ No newline at end of file +``` diff --git a/doc/contribute-to-core-lightning/release-checklist.md b/doc/contribute-to-core-lightning/release-checklist.md index 55f0b8183cc4..8e07ecdcc647 100644 --- a/doc/contribute-to-core-lightning/release-checklist.md +++ b/doc/contribute-to-core-lightning/release-checklist.md @@ -1,9 +1,8 @@ --- -title: "Release Checklist" -slug: "release-checklist" -hidden: false -createdAt: "2023-12-07T10:00:00.000Z" -updatedAt: "2023-12-07T10:00:00.000Z" +title: Release Checklist +slug: release-checklist +privacy: + view: public --- # Release checklist diff --git a/doc/contribute-to-core-lightning/security-policy.md b/doc/contribute-to-core-lightning/security-policy.md index d1c76f2361da..6f950bc69704 100644 --- a/doc/contribute-to-core-lightning/security-policy.md +++ b/doc/contribute-to-core-lightning/security-policy.md @@ -1,10 +1,10 @@ --- -title: "Security policy" -slug: "security-policy" -excerpt: "Learn how to responsibly report a security issue." -hidden: false -createdAt: "2022-12-09T09:58:38.899Z" -updatedAt: "2025-03-22T15:15:57.281Z" +title: Security policy +slug: security-policy +content: + excerpt: Learn how to responsibly report a security issue. +privacy: + view: public --- ## Supported Versions diff --git a/doc/contribute-to-core-lightning/testing.md b/doc/contribute-to-core-lightning/testing.md index c7092a8de3c7..d7e48443e188 100644 --- a/doc/contribute-to-core-lightning/testing.md +++ b/doc/contribute-to-core-lightning/testing.md @@ -1,10 +1,10 @@ --- -title: "Testing" -slug: "testing" -excerpt: "Understand the testing and code review practices." -hidden: false -createdAt: "2022-12-09T09:58:21.295Z" -updatedAt: "2023-07-13T05:21:39.220Z" +title: Testing +slug: testing +content: + excerpt: Understand the testing and code review practices. +privacy: + view: public --- # Testing From f6ea72a2573384cb291e11c2eefa2209f80cfead Mon Sep 17 00:00:00 2001 From: ShahanaFarooqui Date: Wed, 12 Nov 2025 14:01:56 -0800 Subject: [PATCH 6/7] docs: Upgrade rdme from v8 to v10 --- .github/workflows/rdme-docs-sync.yml | 30 ++++++++++------------------ 1 file changed, 10 insertions(+), 20 deletions(-) diff --git a/.github/workflows/rdme-docs-sync.yml b/.github/workflows/rdme-docs-sync.yml index bf796122900e..bdf6d8f46f70 100644 --- a/.github/workflows/rdme-docs-sync.yml +++ b/.github/workflows/rdme-docs-sync.yml @@ -16,36 +16,26 @@ jobs: uses: actions/checkout@v4 - name: Sync doc/getting-started/ 🚀 - uses: readmeio/rdme@v8 - env: - README_API_KEY: ${{ secrets.README_API_KEY }} + uses: readmeio/rdme@v10 with: - rdme: docs doc/getting-started --key=${{ env.README_API_KEY }} --version=1 + rdme: docs upload ./doc/getting-started --key=${{ secrets.README_API_KEY }} --branch=1 - name: Sync doc/beginners-guide/ 🚀 - uses: readmeio/rdme@v8 - env: - README_API_KEY: ${{ secrets.README_API_KEY }} + uses: readmeio/rdme@v10 with: - rdme: docs doc/beginners-guide --key=${{ env.README_API_KEY }} --version=1 + rdme: docs upload ./doc/beginners-guide --key=${{ secrets.README_API_KEY }} --branch=1 - name: Sync doc/node-operators-guide/ 🚀 - uses: readmeio/rdme@v8 - env: - README_API_KEY: ${{ secrets.README_API_KEY }} + uses: readmeio/rdme@v10 with: - rdme: docs doc/node-operators-guide --key=${{ env.README_API_KEY }} --version=1 + rdme: docs upload ./doc/node-operators-guide --key=${{ secrets.README_API_KEY }} --branch=1 - name: Sync doc/developers-guide/ 🚀 - uses: readmeio/rdme@v8 - env: - README_API_KEY: ${{ secrets.README_API_KEY }} + uses: readmeio/rdme@v10 with: - rdme: docs doc/developers-guide --key=${{ env.README_API_KEY }} --version=1 + rdme: docs upload ./doc/developers-guide --key=${{ secrets.README_API_KEY }} --branch=1 - name: Sync doc/contributing-to-core-lightning/ 🚀 - uses: readmeio/rdme@v8 - env: - README_API_KEY: ${{ secrets.README_API_KEY }} + uses: readmeio/rdme@v10 with: - rdme: docs doc/contribute-to-core-lightning --key=${{ env.README_API_KEY }} --version=1 + rdme: docs upload ./doc/contribute-to-core-lightning --key=${{ secrets.README_API_KEY }} --branch=1 From 6e1fea97ae649dc346fc764cb34b890b42e3be7e Mon Sep 17 00:00:00 2001 From: ShahanaFarooqui Date: Wed, 12 Nov 2025 14:03:08 -0800 Subject: [PATCH 7/7] docs: Update rpc commands sync script as per readme API v2 Changelog-None. --- .github/scripts/sync-rpc-cmds.py | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/.github/scripts/sync-rpc-cmds.py b/.github/scripts/sync-rpc-cmds.py index b278ce47ad0a..6b606354f697 100644 --- a/.github/scripts/sync-rpc-cmds.py +++ b/.github/scripts/sync-rpc-cmds.py @@ -1,14 +1,15 @@ import os +from urllib.parse import quote from time import sleep import requests import re from enum import Enum # readme url -URL = "https://dash.readme.com/api/v1" +URL = "https://api.readme.com/v2/branches/stable" # category id for API reference CATEGORY_ID = "685ce4df1df887006ff221c5" -CATEGORY_SLUG = "json-rpc-apis" +CATEGORY_SLUG = "JSON-RPC API Reference" class Action(Enum): @@ -18,9 +19,9 @@ class Action(Enum): def getListOfRPCDocs(headers): - response = requests.get(f"{URL}/categories/{CATEGORY_SLUG}/docs", headers=headers) + response = requests.get(f"{URL}/categories/reference/{quote(CATEGORY_SLUG)}/pages", headers=headers) if response.status_code == 200: - return response.json() + return response.json().get('data', []) else: return [] @@ -30,28 +31,30 @@ def publishDoc(action, title, body, order, headers): "title": title, "type": "basic", "body": body, - "category": CATEGORY_ID, + "category": { + "id": CATEGORY_ID + }, "hidden": False, "order": order, } - # title == slug if action == Action.ADD: # create doc - response = requests.post(URL + "/docs", json=payload, headers=headers) + payload['slug'] = title + response = requests.post(URL + "/reference", json=payload, headers=headers) if response.status_code != 201: print(response.text) else: print("Created ", title) elif action == Action.UPDATE: # update doc - response = requests.put(f"{URL}/docs/{title}", json=payload, headers=headers) + response = requests.patch(f"{URL}/reference/{title}", json=payload, headers=headers) if response.status_code != 200: print(response.text) else: print("Updated ", title) elif action == Action.DELETE: # delete doc - response = requests.delete(f"{URL}/docs/{title}", headers=headers) + response = requests.delete(f"{URL}/reference/{title}", headers=headers) if response.status_code != 204: print(response.text) else: @@ -79,7 +82,7 @@ def main(): headers = { "accept": "application/json", "content-type": "application/json", - "authorization": "Basic " + os.environ.get("README_API_KEY"), + "Authorization": "Bearer " + os.environ.get("README_API_KEY"), } # path to the rst file from where we fetch all the RPC commands