docs: Updated developers-guide docs for v10

ShahanaFarooqui · ShahanaFarooqui · commit a0295fe1deb1 · 2025-11-12T14:35:09.000-08:00
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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.
+- **[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
@@ -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
@@ -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.
+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
@@ -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
@@ -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
@@ -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
@@ -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.
+"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
@@ -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.
+> 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
@@ -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
@@ -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
 ---
+
