From b54c2b95c5e833c8f2a1eb344ef8ecabf577bb16 Mon Sep 17 00:00:00 2001 From: Conor Okus Date: Wed, 7 May 2025 17:33:09 -0400 Subject: [PATCH 1/2] Adds LLMS text file --- docs/.vuepress/public/llms.txt | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/.vuepress/public/llms.txt diff --git a/docs/.vuepress/public/llms.txt b/docs/.vuepress/public/llms.txt new file mode 100644 index 00000000..b652db49 --- /dev/null +++ b/docs/.vuepress/public/llms.txt @@ -0,0 +1,32 @@ +# Lightning Dev Kit + +> A complete Lightning implementation packaged as an SDK. + +Important notes: + +- Lightning Development Kit (LDK) is a full and completely standalone Lightning implementation with supporting modules enabling greater flexibility. + +## Docs + +- [Building a node with LDK](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/blob/main/docs/building-a-node-with-ldk/introduction.md): +The following tutorials will show you how to build the simplest lightning node using LDK +- [Installation](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/installation.md) +- [Setting up a ChannelManager](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/setting-up-a-channel-manager.md): +The ChannelManager is responsible for several tasks related to managing channel state. This includes keeping track of many channels, sending messages to appropriate channels, creating channels and more. +- [Handling Events](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/handling-events.md): +LDK requires that you handle many different events throughout your app's life cycle. +- [Setting up a PeerManager](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/setting-up-a-peer-manager.md): +The PeerManager is responsible for managing a set of peer connections and data associated with those peers. +- [Connect to Peers](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/connect-to-peers.md) +- [Opening a Channel](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/opening-a-channel.md) +- [Sending Payments](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/sending-payments.md) +- [Receiving Payments](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/receiving-payments.md) +- [Closing a Channel](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/closing-a-channel.md) + +## Examples + +- [Rust Sample Node](https://raw.githubusercontent.com/lightningdevkit/ldk-sample/refs/heads/main/src/main.rs) + +## LDK Node + +- [LDK Node](https://github.com/lightningdevkit/ldk-node/edit/main/README.md): A ready-to-go Lightning node library built using LDK and BDK. \ No newline at end of file From 063d6a01721e0ab322e811923c694455eaa8215e Mon Sep 17 00:00:00 2001 From: Conor Okus Date: Thu, 8 May 2025 21:32:08 -0400 Subject: [PATCH 2/2] Update docs/.vuepress/public/llms.txt Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/.vuepress/public/llms.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/.vuepress/public/llms.txt b/docs/.vuepress/public/llms.txt index b652db49..0850584d 100644 --- a/docs/.vuepress/public/llms.txt +++ b/docs/.vuepress/public/llms.txt @@ -10,7 +10,8 @@ Important notes: - [Building a node with LDK](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/blob/main/docs/building-a-node-with-ldk/introduction.md): The following tutorials will show you how to build the simplest lightning node using LDK -- [Installation](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/installation.md) +- [Installation](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/installation.md): +Learn how to install the Lightning Development Kit (LDK) and set up your environment. - [Setting up a ChannelManager](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/setting-up-a-channel-manager.md): The ChannelManager is responsible for several tasks related to managing channel state. This includes keeping track of many channels, sending messages to appropriate channels, creating channels and more. - [Handling Events](https://raw.githubusercontent.com/lightningdevkit/lightningdevkit.org/refs/heads/main/docs/building-a-node-with-ldk/handling-events.md):