docs: Updated contribute-to-core-lightning docs for v10
This commit is contained in:
committed by
Rusty Russell
parent
367efcf643
commit
529cc7d4bc
@@ -1,9 +1,8 @@
|
|||||||
---
|
---
|
||||||
title: "Code Generation"
|
title: Code Generation
|
||||||
slug: "code-generation"
|
slug: code-generation
|
||||||
hidden: false
|
privacy:
|
||||||
createdAt: "2023-04-22T12:29:01.116Z"
|
view: public
|
||||||
updatedAt: "2024-01-18T12:44:47.814Z"
|
|
||||||
---
|
---
|
||||||
The CLN project has a multitude of interfaces, most of which are generated from an abstract schema:
|
The CLN project has a multitude of interfaces, most of which are generated from an abstract schema:
|
||||||
|
|
||||||
|
|||||||
@@ -1,9 +1,8 @@
|
|||||||
---
|
---
|
||||||
title: "Coding Style Guidelines"
|
title: Coding Style Guidelines
|
||||||
slug: "coding-style-guidelines"
|
slug: coding-style-guidelines
|
||||||
hidden: false
|
privacy:
|
||||||
createdAt: "2023-01-25T05:34:10.822Z"
|
view: public
|
||||||
updatedAt: "2023-07-13T05:11:09.525Z"
|
|
||||||
---
|
---
|
||||||
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).
|
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).
|
||||||
|
|
||||||
|
|||||||
@@ -1,9 +1,8 @@
|
|||||||
---
|
---
|
||||||
title: "Writing JSON Schemas"
|
title: Writing JSON Schemas
|
||||||
slug: "writing-json-schemas"
|
slug: writing-json-schemas
|
||||||
hidden: false
|
privacy:
|
||||||
createdAt: "2023-01-25T05:46:43.718Z"
|
view: public
|
||||||
updatedAt: "2024-01-18T15:36:28.523Z"
|
|
||||||
---
|
---
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
---
|
---
|
||||||
title: "CLN Architecture"
|
title: CLN Architecture
|
||||||
slug: "contribute-to-core-lightning"
|
slug: contribute-to-core-lightning
|
||||||
excerpt: "Familiarise yourself with the core components of Core Lightning."
|
content:
|
||||||
hidden: false
|
excerpt: Familiarise yourself with the core components of Core Lightning.
|
||||||
createdAt: "2022-11-18T14:28:33.564Z"
|
privacy:
|
||||||
updatedAt: "2023-02-21T15:12:37.888Z"
|
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.
|
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.
|
||||||
|
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
---
|
---
|
||||||
title: "Contributor Workflow"
|
title: Contributor Workflow
|
||||||
slug: "contributor-workflow"
|
slug: contributor-workflow
|
||||||
excerpt: "Learn the practical process and guidelines for contributing."
|
content:
|
||||||
hidden: false
|
excerpt: Learn the practical process and guidelines for contributing.
|
||||||
createdAt: "2022-12-09T09:57:57.245Z"
|
privacy:
|
||||||
updatedAt: "2023-07-12T13:40:58.465Z"
|
view: public
|
||||||
---
|
---
|
||||||
## Build and Development
|
## Build and Development
|
||||||
|
|
||||||
|
|||||||
@@ -1,9 +1,8 @@
|
|||||||
---
|
---
|
||||||
title: "Docker Images"
|
title: Docker Images
|
||||||
slug: "docker-images"
|
slug: docker-images
|
||||||
hidden: false
|
privacy:
|
||||||
createdAt: "2023-12-07T10:00:00.000Z"
|
view: public
|
||||||
updatedAt: "2023-12-07T10:00:00.000Z"
|
|
||||||
---
|
---
|
||||||
# Setting up Docker's Buildx
|
# Setting up Docker's Buildx
|
||||||
|
|
||||||
@@ -131,4 +130,4 @@ docker exec -it <container-id-from-step2> bash
|
|||||||
```shell
|
```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
|
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
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -1,9 +1,8 @@
|
|||||||
---
|
---
|
||||||
title: "Release Checklist"
|
title: Release Checklist
|
||||||
slug: "release-checklist"
|
slug: release-checklist
|
||||||
hidden: false
|
privacy:
|
||||||
createdAt: "2023-12-07T10:00:00.000Z"
|
view: public
|
||||||
updatedAt: "2023-12-07T10:00:00.000Z"
|
|
||||||
---
|
---
|
||||||
# Release checklist
|
# Release checklist
|
||||||
|
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
---
|
---
|
||||||
title: "Security policy"
|
title: Security policy
|
||||||
slug: "security-policy"
|
slug: security-policy
|
||||||
excerpt: "Learn how to responsibly report a security issue."
|
content:
|
||||||
hidden: false
|
excerpt: Learn how to responsibly report a security issue.
|
||||||
createdAt: "2022-12-09T09:58:38.899Z"
|
privacy:
|
||||||
updatedAt: "2025-03-22T15:15:57.281Z"
|
view: public
|
||||||
---
|
---
|
||||||
## Supported Versions
|
## Supported Versions
|
||||||
|
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
---
|
---
|
||||||
title: "Testing"
|
title: Testing
|
||||||
slug: "testing"
|
slug: testing
|
||||||
excerpt: "Understand the testing and code review practices."
|
content:
|
||||||
hidden: false
|
excerpt: Understand the testing and code review practices.
|
||||||
createdAt: "2022-12-09T09:58:21.295Z"
|
privacy:
|
||||||
updatedAt: "2023-07-13T05:21:39.220Z"
|
view: public
|
||||||
---
|
---
|
||||||
# Testing
|
# Testing
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user