Skip to content

Add Getting Started with LDK Node guide #315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Camillarhi wants to merge 1 commit into
base: main
Choose a base branch
from
+1,546 −0
Open

Add Getting Started with LDK Node guide #315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.vitepress/config.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ const docsSidebar: DefaultTheme.SidebarItem[] = [
{ text: 'Closing a Channel', link: '/building-a-node-with-ldk/closing-a-channel' },
],
},
{ text: 'Getting Started with LDK Node', link: '/getting-started-with-ldk-node' },
{ text: 'Running a sample LDK node', link: '/running-a-sample-ldk-node' },
{
text: 'Advanced Guides',
Expand Down
1 change: 1 addition & 0 deletions docs/.vitepress/theme/components/SiteFooter.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ const columns: Column[] = [
children: [
{ text: 'Introduction', link: '/introduction/' },
{ text: 'Building a node with LDK', link: '/building-a-node-with-ldk/introduction/' },
{ text: 'Getting Started with LDK Node', link: '/getting-started-with-ldk-node/' },

@ConorOkus ConorOkus Aug 4, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit, and honestly pre-existing rather than yours: the trailing slash makes this 404.

https://lightningdevkit.org/running-a-sample-ldk-node/  -> 404
https://lightningdevkit.org/running-a-sample-ldk-node   -> 200

Every entry in this footer list has the same trailing slash, so it's a site-wide thing, not something this PR introduced — but this adds one more instance. Your sidebar entry in config.mts uses the correct bare form already. Note ignoreDeadLinks: true means the build won't flag it.

Happy for this to be out of scope; just flagging since you're touching the file.

{ text: 'Running a sample LDK node', link: '/running-a-sample-ldk-node/' },
{ text: 'Architecture', link: '/introduction/architecture/' },
{ text: 'Blockchain Data', link: '/blockchain_data/' },
Expand Down
5 changes: 5 additions & 0 deletions docs/.vuepress/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ const docsSidebar = [
["/building-a-node-with-ldk/closing-a-channel", "Closing a Channel"],
],
},
["/getting-started-with-ldk-node", "Getting Started with LDK Node"],
"/running-a-sample-ldk-node",
{
title: "Blockchain Data",
Expand Down Expand Up @@ -221,6 +222,10 @@ module.exports = {
text: "Building a node with LDK",
link: "/building-a-node-with-ldk/introduction/",
},
{
text: "Getting Started with LDK Node",
link: "/getting-started-with-ldk-node/",
},
{
text: "Running a sample LDK node",
link: "/running-a-sample-ldk-node/",
Expand Down
Loading
Loading