Merge pull request lightningdevkit#1 from payjoin/init-payjoin

Init payjoin

Author: DanGould

.gitignore

@@ -5,6 +5,7 @@
 /docs/.vuepress/dist
 
 # Misc
+.vscode
 .DS_Store
 .env.local
 .env.development.local

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 lightningdevkit
+Copyright (c) 2023 payjoindevkit
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,6 +1,6 @@
-# Lightning Dev Kit Documentation
+# Payjoin Dev Kit Documentation
 
-[![Build Status](https://github.com/lightningdevkit/lightningdevkit.org/workflows/Build/badge.svg)](https://github.com/lightningdevkit/lightningdevkit.org/actions?query=workflow%3A%22Build%22)
+[![Build Status](https://github.com/payjoin/payjoindevkit.org/workflows/Build/badge.svg)](https://github.com/payjoin/payjoindevkit.org/actions?query=workflow%3A%22Build%22)
 
 ### Build the Documentation Locally
 

docs/.vuepress/config.js

@@ -1,10 +1,10 @@
 const { resolve } = require('path')
 const themeConfig = require('@spiralbtc/vuepress-devkit-theme/config')
 
-const title = 'Lightning Dev Kit Documentation'
-const baseUrl = 'https://lightningdevkit.org'
-const githubUrl = 'https://github.com/lightningdevkit'
-const discordUrl = 'https://discord.gg/xaYE3pDQpm'
+const title = 'Payjoin Dev Kit Documentation'
+const baseUrl = 'https://payjoindevkit.org'
+const githubUrl = 'https://github.com/payjoin'
+const discordUrl = 'https://discord.gg/6rJD9R684h'
 const themeColor = '#ffffff'
 
 const docsSidebar = [
@@ -20,68 +20,15 @@ const docsSidebar = [
           ['/introduction/use_cases', 'Use Cases'],
         ]
       },
-      '/running-a-sample-ldk-node',
-      {
-        title: 'Overview',
-        collapsable: true,
-        children: [
-          ['/overview/architecture', 'Architecture'],
-          ['/overview/peer-management', 'Peer Management'],
-          ['/overview/persistent_storage', 'Persistent Storage'],
-          ['/overview/blockchain_data', 'Blockchain Data'],
-          ['/overview/wallet_management', 'Wallet Management'],
-          ['/overview/networking', 'Networking'],
-          ['/overview/private_key_management', 'Private Key Management'],
-          ['/overview/transactions', 'Transactions'],
-          ['/overview/random_number_generation', 'Random Number Generation'],
-        ]
-      },
-      {
-        title: 'Payments',
-        path: '/payments/',
-        collapsable: true,
-        children: [
-          ['/payments/connecting_peers', 'Connecting Peers'],
-          ['/payments/managing_channels', 'Managing Channels'],
-          ['/payments/sending_payments', 'Sending Payments'],
-          ['/payments/receiving_payments', 'Receiving Payments'],
-        ]
-      },
-      {
-        title: 'Blockchain Data',
-        collapsable: true,
-        children: [
-          ['/blockchain_data/introduction', 'Introduction'],
-          ['/blockchain_data/chain_activity', 'Chain Activity'],
-          ['/blockchain_data/block_source', 'Block Source'],
-          ['/blockchain_data/full_blocks', 'Full Blocks'],
-          ['/blockchain_data/pre_filtered_blocks', 'Pre-filtered Blocks'],
-          ['/blockchain_data/confirmed_transactions', 'Confirmed Transactions'],
-          ['/blockchain_data/transaction_broadcasting', 'Transaction Broadcasting'],
-        ]
-      },
-      '/key_management',
+      '/send-receive-test-payjoins',
       '/examples',
     ]
   },
   {
     title: 'API Reference',
     collapsable: false,
     children: [
-      {
-        title: "Rust",
-        collapsable: true,
-        children: [
-          ['https://docs.rs/lightning/*/lightning/', 'lightning'],
-          ['https://docs.rs/lightning-background-processor/*/lightning_background_processor/', 'lightning-background-processor'],
-          ['https://docs.rs/lightning-block-sync/*/lightning_block_sync/', 'lightning-block-sync'],
-          ['https://docs.rs/lightning-invoice/*/lightning_invoice/', 'lightning-invoice'],
-          ['https://docs.rs/lightning-net-tokio/*/lightning_net_tokio/', 'lightning-net-tokio'],
-          ['https://docs.rs/lightning-persister/*/lightning_persister/', 'lightning-persister'],
-          ['https://docs.rs/lightning-rapid-gossip-sync/*/lightning_rapid_gossip_sync/', 'lightning-rapid-gossip-sync']
-        ]
-      },
-      ['https://github.com/arik-so/SwiftLightning/tree/master/Documentation', 'Swift']
+      ['https://docs.rs/payjoin/*/payjoin', 'Rust']
     ],
   }
 ]
@@ -92,8 +39,6 @@ const tutorialSidebar = [
     collapsable: false,
     children: [
       '/tutorials/getting-started',
-      '/tutorials/build_a_node_in_java',
-      '/tutorials/build_a_node_in_rust'
     ],
   }
 ]
@@ -152,8 +97,8 @@ module.exports = {
         link: '/tutorials/getting-started'
       },
       {
-        text: 'Case Studies',
-        link: '/case-studies'
+        text: 'Case Study',
+        link: 'https://bitcoin.design/guide/case-studies/payjoin/'
       },
       {
         text: 'Blog',
@@ -186,24 +131,8 @@ module.exports = {
               link: '/introduction/'
             },
             {
-              text: 'Sample LDK node',
-              link: '/running-a-sample-ldk-node/'
-            },
-            {
-              text: 'Architecture',
-              link: '/overview/architecture/'
-            },
-            {
-              text: 'Payments',
-              link: '/payments/'
-            },
-            {
-              text: 'Blockchain Data',
-              link: '/blockchain_data/introduction/'
-            },
-            {
-              text: 'Key Management',
-              link: '/key_management/'
+              text: 'Send and Receive Test Payjoins',
+              link: '/send-receive-test-payjoins/'
             },
             {
               text: 'Examples',
@@ -215,54 +144,37 @@ module.exports = {
           title: 'Community',
           children: [
             {
-              text: 'GitHub',
-              link: githubUrl,
-              rel: 'noopener noreferrer'
-            },
-            {
-              text: 'Twitter',
-              link: "https://twitter.com/lightningdevkit",
-              rel: 'noopener noreferrer'
-            },
-            {
-              text: 'Chat on Discord',
+              text: 'Discord',
               link: discordUrl,
               rel: 'noopener noreferrer'
             },
             {
-              text: 'LDK Calendar',
-              link: "https://calendar.google.com/calendar/embed?src=c_e6fv6vlshbpoob2mmbvblkkoj4%40group.calendar.google.com",
-              rel: 'noopener noreferrer'
-            },
-            {
-              text: 'LDK Review Club',
-              link: "http://ldk.reviews/",
-              rel: 'noopener noreferrer'
-            },
-            {
-              text: 'Code of Conduct',
-              link: "/code_of_conduct",
+              text: 'GitHub',
+              link: githubUrl,
               rel: 'noopener noreferrer'
             },
             {
-              text: 'Reporting a Vulnerability',
-              link: "https://github.com/lightningdevkit/rust-lightning/blob/main/SECURITY.md",
+              text: 'PDK Roadmap',
+              link: githubUrl + "https://github.com/orgs/payjoin/projects/1",
               rel: 'noopener noreferrer'
             },
-
           ]
         },
         {
           title: 'More',
           children: [
+            {
+              text: 'Payjoin.org',
+              link: 'https://payjoin.org'
+            },
             {
               text: 'Blog',
               link: '/blog/'
-            }
+            },
           ]
         }
       ],
-      copyright: 'Copyright © 2023 LDK Developers'
+      copyright: 'Copyright © 2023 PDK Developers'
     }
   }
 }

docs/.vuepress/public/css/variables.css

@@ -1,25 +1,25 @@
 :root {
-  --docs-primary-light: #0F31F7;
-  --docs-primary-dark: #76F3CD;
-  --docs-dark: #000628;
+  --docs-primary-light: #C71585;
+  --docs-primary-dark: #F75394;
+  --docs-dark: #0F1010;
 
   --docs-note-text: var(--docs-black) !important;
-  --docs-note-bg: #F5F7FF !important;
-  --docs-code-bg: #E6EAFE;
-  --docs-pre-bg: #020A36;
+  --docs-note-bg: #F6D8E7 !important;
+  --docs-code-bg: #F0D1E1;
+  --docs-pre-bg: #17051B;
 }
 
 :root[data-theme="dark"] {
-  --docs-code-bg: #06463C;
-  --docs-pre-bg: #002547;
+  --docs-code-bg: #401D29;
+  --docs-pre-bg: #0A070F;
   --docs-note-text: var(--docs-white) !important;
   --docs-note-bg: var(--docs-pre-bg) !important;
 }
 
 @media (prefers-color-scheme: dark) {
   :root:not([data-theme]) {
-    --docs-code-bg: #06463C;
-    --docs-pre-bg: #002547;
+    --docs-code-bg: #401D29;
+    --docs-pre-bg: #0A070F;
     --docs-note-text: var(--docs-white) !important;
     --docs-note-bg: var(--docs-pre-bg) !important;
   }