Skip to content

Commit 5044bdc

Browse files
author
Conor Okus
committed
Restructure nav
1 parent 69e0ce1 commit 5044bdc

22 files changed

+55
-133
lines changed

docs/.vuepress/config.js

Lines changed: 52 additions & 126 deletions
Original file line numberDiff line numberDiff line change
@@ -16,35 +16,60 @@ 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+
["/introduction/random_number_generation", "Random Number Generation"],
3530
],
3631
},
3732
{
38-
title: "Payments",
39-
path: "/payments/",
33+
title: "Building a node with LDK",
4034
collapsable: true,
4135
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"],
36+
["/building-a-node-with-ldk/introduction", "Introduction"],
37+
["/building-a-node-with-ldk/installation", "Installation"],
38+
[
39+
"/building-a-node-with-ldk/setting-up-a-channel-manager",
40+
"Setting up a Channel Manager",
41+
],
42+
[
43+
"/building-a-node-with-ldk/handling-events",
44+
"Handling Events",
45+
],
46+
[
47+
"/building-a-node-with-ldk/setting-up-a-peer-manager",
48+
"Setting up a Peer Manager",
49+
],
50+
[
51+
"/building-a-node-with-ldk/connect-to-peers",
52+
"Connect to Peers",
53+
],
54+
[
55+
"/building-a-node-with-ldk/opening-a-channel",
56+
"Opening a Channel",
57+
],
58+
[
59+
"/building-a-node-with-ldk/sending-payments",
60+
"Sending Payments",
61+
],
62+
[
63+
"/building-a-node-with-ldk/receiving-payments",
64+
"Receiving Payments",
65+
],
66+
[
67+
"/building-a-node-with-ldk/closing-a-channel",
68+
"Closing a Channel",
69+
],
4670
],
4771
},
72+
"/running-a-sample-ldk-node",
4873
{
4974
title: "Blockchain Data",
5075
collapsable: true,
@@ -116,54 +141,6 @@ const docsSidebar = [
116141
},
117142
];
118143

119-
const tutorialSidebar = [
120-
{
121-
title: "Tutorials",
122-
collapsable: false,
123-
children: [
124-
"/tutorials/getting-started",
125-
{
126-
title: "Building a node with LDK",
127-
collapsable: false,
128-
children: [
129-
["/tutorials/building-a-node-with-ldk/introduction", "Introduction"],
130-
[
131-
"/tutorials/building-a-node-with-ldk/setting-up-a-channel-manager",
132-
"Setting up a Channel Manager",
133-
],
134-
[
135-
"/tutorials/building-a-node-with-ldk/handling-events",
136-
"Handling Events",
137-
],
138-
[
139-
"/tutorials/building-a-node-with-ldk/setting-up-a-peer-manager",
140-
"Setting up a Peer Manager",
141-
],
142-
[
143-
"/tutorials/building-a-node-with-ldk/connect-to-peers",
144-
"Connect to Peers",
145-
],
146-
[
147-
"/tutorials/building-a-node-with-ldk/opening-a-channel",
148-
"Opening a Channel",
149-
],
150-
[
151-
"/tutorials/building-a-node-with-ldk/sending-payments",
152-
"Sending Payments",
153-
],
154-
[
155-
"/tutorials/building-a-node-with-ldk/receiving-payments",
156-
"Receiving Payments",
157-
],
158-
[
159-
"/tutorials/building-a-node-with-ldk/closing-a-channel",
160-
"Closing a Channel",
161-
],
162-
],
163-
},
164-
],
165-
},
166-
];
167144

168145
const blogSidebar = [
169146
{
@@ -218,10 +195,6 @@ module.exports = {
218195
text: "Docs",
219196
link: "/introduction/",
220197
},
221-
{
222-
text: "Tutorials",
223-
link: "/tutorials/getting-started",
224-
},
225198
{
226199
text: "Blog",
227200
link: "/blog/",
@@ -240,7 +213,6 @@ module.exports = {
240213
sidebar: {
241214
"/_blog/": blogSidebar,
242215
"/blog/": blogSidebar,
243-
"/tutorials/": tutorialSidebar,
244216
"/": docsSidebar,
245217
},
246218
footer: {
@@ -253,16 +225,16 @@ module.exports = {
253225
link: "/introduction/",
254226
},
255227
{
256-
text: "Sample LDK node",
257-
link: "/running-a-sample-ldk-node/",
228+
text: "Building a node with LDK",
229+
link: "/building-a-node-with-ldk/introduction",
258230
},
259231
{
260-
text: "Architecture",
261-
link: "/overview/architecture/",
232+
text: "Running a sample LDK node",
233+
link: "/running-a-sample-ldk-node/",
262234
},
263235
{
264-
text: "Payments",
265-
link: "/payments/",
236+
text: "Architecture",
237+
link: "/introduction/architecture/",
266238
},
267239
{
268240
text: "Blockchain Data",
@@ -313,39 +285,6 @@ module.exports = {
313285
},
314286
],
315287
},
316-
{
317-
title: "Docs",
318-
children: [
319-
{
320-
text: "Introduction",
321-
link: "/introduction/",
322-
},
323-
{
324-
text: "Sample LDK node",
325-
link: "/running-a-sample-ldk-node/",
326-
},
327-
{
328-
text: "Architecture",
329-
link: "/overview/architecture/",
330-
},
331-
{
332-
text: "Payments",
333-
link: "/payments/",
334-
},
335-
{
336-
text: "Blockchain Data",
337-
link: "/blockchain_data/introduction/",
338-
},
339-
{
340-
text: "Key Management",
341-
link: "/key_management/",
342-
},
343-
{
344-
text: "Examples",
345-
link: "/examples/",
346-
},
347-
],
348-
},
349288
{
350289
title: "Resources",
351290
children: [
@@ -362,10 +301,6 @@ module.exports = {
362301
{
363302
title: "Other",
364303
children: [
365-
{
366-
text: "Tutorials",
367-
link: "/tutorials/getting-started/",
368-
},
369304
{
370305
text: "Bitcoin Dev Kit",
371306
link: "https://bitcoindevkit.org/",
@@ -377,15 +312,6 @@ module.exports = {
377312
},
378313
],
379314
},
380-
{
381-
title: "More",
382-
children: [
383-
{
384-
text: "Blog",
385-
link: "/blog/",
386-
},
387-
],
388-
},
389315
],
390316
copyright: "Copyright © 2024 LDK Developers",
391317
},
File renamed without changes.

docs/introduction/index.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,7 @@ You can build a Lightning node without needing to worry about getting all of the
66

77
Our [sample node](https://github.com/lightningdevkit/ldk-sample) showcases how LDK can be customised. It fetches blockchain data and transacts on-chain via Bitcoin Core RPC/REST. The individual components of the sample are composable. For example, the sample writes channel state to the local filesystem, but this component could be replaced with one that writes this data to the cloud or to multiple locations. You can pick the off-the-shelf parts you want and replace the rest.
88

9-
## To jump into integrating LDK with your application
10-
11-
* [Click here for Java](../tutorials/build_a_node_in_java.md)
12-
* [Click here for Rust](../tutorials/build_a_node_in_rust.md)
9+
To start building a node with LDK [click here.](../building-a-node-with-ldk/introduction.md)
1310

1411
## References
1512

File renamed without changes.
File renamed without changes.

docs/introduction/use_cases.md renamed to docs/introduction/use-cases.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,12 @@ supports routing data being fetched via the Lightning P2P protocol, an external
1717
service, or routes can be calculated off-device. It also provides cross-platform
1818
compatibility for free, allowing synchronization of Lightning state across
1919
devices and, as long as there is protection from simultaneous updates, users to
20-
access their wallet on any device. See the [Overview](../../overview/architecture) page for more
20+
access their wallet on any device. See the [architecure](../architecture) page for more
2121
details on the interfaces LDK provides for integration.
2222

2323
## HSMs (Hardware Security Modules)
2424

25-
LDK Supports various HSM configurations. In conjunction with the [Lightning
26-
Signer project](https://github.com/lightning-signer/) , an external HSM can be
25+
LDK Supports various HSM configurations. In conjunction with the [Validating Lightning Signer](https://vls.tech/)project, an external HSM can be
2726
used to verify most protocol details about states before signing, ensuring host
2827
compromise cannot steal funds by broadcasting revoked states. For nodes seeking
2928
a higher level of assurance, the entire LDK channel state machine can

0 commit comments

Comments
 (0)