Skip to content

Commit ea11fb3

Browse files
ShahanaFarooquiShahanaFarooqui
committed
docs: Updated contribute-to-core-lightning docs for v10
1 parent a0295fe commit ea11fb3

File tree

9 files changed

+45
-50
lines changed

9 files changed

+45
-50
lines changed

‎doc/contribute-to-core-lightning/code-generation.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2-
title: "Code Generation"
3-
slug: "code-generation"
4-
hidden: false
5-
createdAt: "2023-04-22T12:29:01.116Z"
6-
updatedAt: "2024-01-18T12:44:47.814Z"
2+
title: Code Generation
3+
slug: code-generation
4+
privacy:
5+
view: public
76
---
87
The CLN project has a multitude of interfaces, most of which are generated from an abstract schema:
98

‎doc/contribute-to-core-lightning/coding-style-guidelines.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2-
title: "Coding Style Guidelines"
3-
slug: "coding-style-guidelines"
4-
hidden: false
5-
createdAt: "2023-01-25T05:34:10.822Z"
6-
updatedAt: "2023-07-13T05:11:09.525Z"
2+
title: Coding Style Guidelines
3+
slug: coding-style-guidelines
4+
privacy:
5+
view: public
76
---
87
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).
98

‎doc/contribute-to-core-lightning/coding-style-guidelines/writing-json-schemas.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2-
title: "Writing JSON Schemas"
3-
slug: "writing-json-schemas"
4-
hidden: false
5-
createdAt: "2023-01-25T05:46:43.718Z"
6-
updatedAt: "2024-01-18T15:36:28.523Z"
2+
title: Writing JSON Schemas
3+
slug: writing-json-schemas
4+
privacy:
5+
view: public
76
---
87
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.
98

‎doc/contribute-to-core-lightning/contribute-to-core-lightning.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: "CLN Architecture"
3-
slug: "contribute-to-core-lightning"
4-
excerpt: "Familiarise yourself with the core components of Core Lightning."
5-
hidden: false
6-
createdAt: "2022-11-18T14:28:33.564Z"
7-
updatedAt: "2023-02-21T15:12:37.888Z"
2+
title: CLN Architecture
3+
slug: contribute-to-core-lightning
4+
content:
5+
excerpt: Familiarise yourself with the core components of Core Lightning.
6+
privacy:
7+
view: public
88
---
99
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.
1010

‎doc/contribute-to-core-lightning/contributor-workflow.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: "Contributor Workflow"
3-
slug: "contributor-workflow"
4-
excerpt: "Learn the practical process and guidelines for contributing."
5-
hidden: false
6-
createdAt: "2022-12-09T09:57:57.245Z"
7-
updatedAt: "2023-07-12T13:40:58.465Z"
2+
title: Contributor Workflow
3+
slug: contributor-workflow
4+
content:
5+
excerpt: Learn the practical process and guidelines for contributing.
6+
privacy:
7+
view: public
88
---
99
## Build and Development
1010

‎doc/contribute-to-core-lightning/docker-images.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2-
title: "Docker Images"
3-
slug: "docker-images"
4-
hidden: false
5-
createdAt: "2023-12-07T10:00:00.000Z"
6-
updatedAt: "2023-12-07T10:00:00.000Z"
2+
title: Docker Images
3+
slug: docker-images
4+
privacy:
5+
view: public
76
---
87
# Setting up Docker's Buildx
98

@@ -131,4 +130,4 @@ docker exec -it <container-id-from-step2> bash
131130
```shell
132131
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
133132

134-
```
133+
```

‎doc/contribute-to-core-lightning/release-checklist.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2-
title: "Release Checklist"
3-
slug: "release-checklist"
4-
hidden: false
5-
createdAt: "2023-12-07T10:00:00.000Z"
6-
updatedAt: "2023-12-07T10:00:00.000Z"
2+
title: Release Checklist
3+
slug: release-checklist
4+
privacy:
5+
view: public
76
---
87
# Release checklist
98

‎doc/contribute-to-core-lightning/security-policy.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: "Security policy"
3-
slug: "security-policy"
4-
excerpt: "Learn how to responsibly report a security issue."
5-
hidden: false
6-
createdAt: "2022-12-09T09:58:38.899Z"
7-
updatedAt: "2025-03-22T15:15:57.281Z"
2+
title: Security policy
3+
slug: security-policy
4+
content:
5+
excerpt: Learn how to responsibly report a security issue.
6+
privacy:
7+
view: public
88
---
99
## Supported Versions
1010

‎doc/contribute-to-core-lightning/testing.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: "Testing"
3-
slug: "testing"
4-
excerpt: "Understand the testing and code review practices."
5-
hidden: false
6-
createdAt: "2022-12-09T09:58:21.295Z"
7-
updatedAt: "2023-07-13T05:21:39.220Z"
2+
title: Testing
3+
slug: testing
4+
content:
5+
excerpt: Understand the testing and code review practices.
6+
privacy:
7+
view: public
88
---
99
# Testing
1010

0 commit comments

Comments
 (0)