From 529cc7d4bca505d418a96b6e7cae791acdc0a20b Mon Sep 17 00:00:00 2001 From: ShahanaFarooqui Date: Wed, 12 Nov 2025 14:34:06 -0800 Subject: [PATCH] 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 58f45c751..c58c94870 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 c9400dc30..3b5a04c4f 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 d51b71419..110793183 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 0c5d2320f..58eef148f 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 1d59f9de8..e4ba0d614 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 0e1549364..476b8f134 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 55f0b8183..8e07ecdcc 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 d1c76f236..6f950bc69 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 c7092a8de..d7e48443e 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