Skip to content

Commit 20dc0a5

Browse files
ConorOkustnull
andauthored
Consolidates building a node tutorial (#156)
* Consolidate building a node tutorials Co-authored-by: Elias Rohrer <[email protected]>
1 parent fa2dd91 commit 20dc0a5

31 files changed

+2826
-18660
lines changed

docs/.vuepress/config.js

Lines changed: 80 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ const themeConfig = require("@spiralbtc/vuepress-devkit-theme/config");
44
const title = "Lightning Dev Kit Documentation";
55
const baseUrl = "https://lightningdevkit.org";
66
const githubUrl = "https://github.com/lightningdevkit";
7-
const discordUrl = "https://discord.gg/xaYE3pDQpm";
7+
const discordUrl = "https://discord.gg/5AcknnMfBw";
88
const themeColor = "#ffffff";
99

1010
const docsSidebar = [
@@ -16,35 +16,48 @@ const docsSidebar = [
1616
title: "Introduction",
1717
path: "/introduction/",
1818
collapsable: true,
19-
children: [["/introduction/use_cases", "Use Cases"]],
20-
},
21-
"/running-a-sample-ldk-node",
22-
{
23-
title: "Overview",
24-
collapsable: true,
2519
children: [
26-
["/overview/architecture", "Architecture"],
27-
["/overview/peer-management", "Peer Management"],
28-
["/overview/persistent_storage", "Persistent Storage"],
29-
["/overview/blockchain_data", "Blockchain Data"],
30-
["/overview/wallet_management", "Wallet Management"],
31-
["/overview/networking", "Networking"],
32-
["/overview/private_key_management", "Private Key Management"],
33-
["/overview/transactions", "Transactions"],
34-
["/overview/random_number_generation", "Random Number Generation"],
20+
["/introduction/use-cases", "Use Cases"],
21+
["/introduction/architecture", "Architecture"],
22+
["/introduction/peer-management", "Peer Management"],
23+
["/introduction/persistent_storage", "Persistent Storage"],
24+
["/introduction/blockchain_data", "Blockchain Data"],
25+
["/introduction/wallet_management", "Wallet Management"],
26+
["/introduction/networking", "Networking"],
27+
["/introduction/private_key_management", "Private Key Management"],
28+
["/introduction/transactions", "Transactions"],
29+
[
30+
"/introduction/random_number_generation",
31+
"Random Number Generation",
32+
],
3533
],
3634
},
3735
{
38-
title: "Payments",
39-
path: "/payments/",
36+
title: "Building a node with LDK",
4037
collapsable: true,
4138
children: [
42-
["/payments/connecting_peers", "Connecting Peers"],
43-
["/payments/managing_channels", "Managing Channels"],
44-
["/payments/sending_payments", "Sending Payments"],
45-
["/payments/receiving_payments", "Receiving Payments"],
39+
["/building-a-node-with-ldk/introduction", "Introduction"],
40+
["/building-a-node-with-ldk/installation", "Installation"],
41+
[
42+
"/building-a-node-with-ldk/setting-up-a-channel-manager",
43+
"Setting up a Channel Manager"
44+
],
45+
["/building-a-node-with-ldk/handling-events", "Handling Events"],
46+
[
47+
"/building-a-node-with-ldk/setting-up-a-peer-manager",
48+
"Setting up a Peer Manager"
49+
],
50+
["/building-a-node-with-ldk/connect-to-peers", "Connect to Peers"],
51+
["/building-a-node-with-ldk/opening-a-channel", "Opening a Channel"],
52+
["/building-a-node-with-ldk/sending-payments", "Sending Payments"],
53+
[
54+
"/building-a-node-with-ldk/receiving-payments",
55+
"Receiving Payments"
56+
],
57+
["/building-a-node-with-ldk/closing-a-channel", "Closing a Channel"],
4658
],
4759
},
60+
"/running-a-sample-ldk-node",
4861
{
4962
title: "Blockchain Data",
5063
collapsable: true,
@@ -57,7 +70,7 @@ const docsSidebar = [
5770
["/blockchain_data/confirmed_transactions", "Confirmed Transactions"],
5871
[
5972
"/blockchain_data/transaction_broadcasting",
60-
"Transaction Broadcasting",
73+
"Transaction Broadcasting"
6174
],
6275
],
6376
},
@@ -76,59 +89,42 @@ const docsSidebar = [
7689
["https://docs.rs/lightning/*/lightning/", "lightning"],
7790
[
7891
"https://docs.rs/lightning-background-processor/*/lightning_background_processor/",
79-
"lightning-background-processor",
92+
"lightning-background-processor"
8093
],
8194
[
8295
"https://docs.rs/lightning-block-sync/*/lightning_block_sync/",
83-
"lightning-block-sync",
96+
"lightning-block-sync"
8497
],
8598
[
8699
"https://docs.rs/lightning-invoice/*/lightning_invoice/",
87-
"lightning-invoice",
100+
"lightning-invoice"
88101
],
89102
[
90103
"https://docs.rs/lightning-net-tokio/*/lightning_net_tokio/",
91-
"lightning-net-tokio",
104+
"lightning-net-tokio"
92105
],
93106
[
94107
"https://docs.rs/lightning-persister/*/lightning_persister/",
95-
"lightning-persister",
108+
"lightning-persister"
96109
],
97110
[
98111
"https://docs.rs/lightning-rapid-gossip-sync/*/lightning_rapid_gossip_sync/",
99-
"lightning-rapid-gossip-sync",
112+
"lightning-rapid-gossip-sync"
100113
],
101114
[
102115
"https://docs.rs/lightning-transaction-sync/*/lightning_transaction_sync/",
103-
"lightning-transaction-sync",
116+
"lightning-transaction-sync"
104117
],
105118
[
106119
"https://docs.rs/lightning-custom-message/*/lightning_custom_message/",
107-
"lightning-custom-message",
120+
"lightning-custom-message"
108121
],
109122
],
110123
},
111124
[
112-
"https://github.com/lightningdevkit/ldk-garbagecollected/tree/main/src/main/java/org/ldk",
113-
"Java/Kotlin",
125+
"https://github.com/arik-so/SwiftLightning/tree/master/Documentation",
126+
"Swift",
114127
],
115-
["https://github.com/lightningdevkit/ldk-swift", "Swift"],
116-
[
117-
"https://github.com/lightningdevkit/ldk-garbagecollected/tree/main/ts",
118-
"TypeScript",
119-
],
120-
],
121-
},
122-
];
123-
124-
const tutorialSidebar = [
125-
{
126-
title: "Tutorials",
127-
collapsable: false,
128-
children: [
129-
"/tutorials/getting-started",
130-
"/tutorials/build_a_node_in_java",
131-
"/tutorials/build_a_node_in_rust",
132128
],
133129
},
134130
];
@@ -186,13 +182,9 @@ module.exports = {
186182
text: "Docs",
187183
link: "/introduction/",
188184
},
189-
{
190-
text: "Tutorials",
191-
link: "/tutorials/getting-started",
192-
},
193185
{
194186
text: "Case Studies",
195-
link: "/case-studies",
187+
link: "/case-studies/",
196188
},
197189
{
198190
text: "Blog",
@@ -212,11 +204,43 @@ module.exports = {
212204
sidebar: {
213205
"/_blog/": blogSidebar,
214206
"/blog/": blogSidebar,
215-
"/tutorials/": tutorialSidebar,
216207
"/": docsSidebar,
217208
},
218209
footer: {
219210
links: [
211+
{
212+
title: "Docs",
213+
children: [
214+
{
215+
text: "Introduction",
216+
link: "/introduction/",
217+
},
218+
{
219+
text: "Building a node with LDK",
220+
link: "/building-a-node-with-ldk/introduction",
221+
},
222+
{
223+
text: "Running a sample LDK node",
224+
link: "/running-a-sample-ldk-node/",
225+
},
226+
{
227+
text: "Architecture",
228+
link: "/introduction/architecture/",
229+
},
230+
{
231+
text: "Blockchain Data",
232+
link: "/blockchain_data/introduction/",
233+
},
234+
{
235+
text: "Key Management",
236+
link: "/key_management/",
237+
},
238+
{
239+
text: "Examples",
240+
link: "/examples/",
241+
},
242+
],
243+
},
220244
{
221245
title: "Community",
222246
children: [
@@ -252,39 +276,6 @@ module.exports = {
252276
},
253277
],
254278
},
255-
{
256-
title: "Docs",
257-
children: [
258-
{
259-
text: "Introduction",
260-
link: "/introduction/",
261-
},
262-
{
263-
text: "Sample LDK node",
264-
link: "/running-a-sample-ldk-node/",
265-
},
266-
{
267-
text: "Architecture",
268-
link: "/overview/architecture/",
269-
},
270-
{
271-
text: "Payments",
272-
link: "/payments/",
273-
},
274-
{
275-
text: "Blockchain Data",
276-
link: "/blockchain_data/introduction/",
277-
},
278-
{
279-
text: "Key Management",
280-
link: "/key_management/",
281-
},
282-
{
283-
text: "Examples",
284-
link: "/examples/",
285-
},
286-
],
287-
},
288279
{
289280
title: "Resources",
290281
children: [
@@ -301,10 +292,6 @@ module.exports = {
301292
{
302293
title: "Other",
303294
children: [
304-
{
305-
text: "Tutorials",
306-
link: "/tutorials/getting-started/",
307-
},
308295
{
309296
text: "Bitcoin Dev Kit",
310297
link: "https://bitcoindevkit.org/",

docs/build_node2.md

Lines changed: 0 additions & 51 deletions
This file was deleted.

0 commit comments

Comments
 (0)