From 857511b1bd391a46465ff51cdfc34c6dababcabc Mon Sep 17 00:00:00 2001 From: Marnix <93143998+MarnixCroes@users.noreply.github.com> Date: Mon, 16 Sep 2024 16:55:27 +0200 Subject: [PATCH] create Backend and Coordinator docs --- README.md | 2 ++ docs/.vuepress/config.ts | 13 +++++++++++++ docs/Backend&Coordinator/Backend.md | 8 ++++++++ docs/Backend&Coordinator/Coordinator.md | 8 ++++++++ docs/Backend&Coordinator/README.md | 25 +++++++++++++++++++++++++ 5 files changed, 56 insertions(+) create mode 100644 docs/Backend&Coordinator/Backend.md create mode 100644 docs/Backend&Coordinator/Coordinator.md create mode 100644 docs/Backend&Coordinator/README.md diff --git a/README.md b/README.md index c40c6e99a8..f4e707c9ec 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,8 @@ If you need help regarding the software specifically, please check out [Discussi * How to contribute to Wasabi. * ## [Wasabi FAQ](https://github.com/WalletWasabi/WasabiDoc/tree/master/docs/FAQ/) * Frequently asked questions. + * ## [Backend & Coordinator](https://github.com/WalletWasabi/WasabiDoc/tree/master/docs/backend&coordinator/) + * Explanations of common words. * ## [Wasabi Glossary](https://github.com/WalletWasabi/WasabiDoc/tree/master/docs/glossary/) * Explanations of common words. diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts index 44c362763b..573d534cb4 100644 --- a/docs/.vuepress/config.ts +++ b/docs/.vuepress/config.ts @@ -102,6 +102,9 @@ export default defineUserConfig({ }, { text: "FAQ", link: "/FAQ/" + }, { + text: "Backend & Coordinator", + link: "/backend&coordinator/" }, { text: "Glossary", link: "/glossary/" @@ -226,6 +229,16 @@ export default defineUserConfig({ ] }], + "/Backend&Coordinator/": [{ + text: "Backend and Coordinator", + collapsable: false, + sidebarDepth: 2, + children: [ + "/Backend&Coordinator/Backend.md", + "/Backend&Coordinator/Coordinator.md" + ] + }], + "/glossary/": [{ text: "Glossary", collapsable: false, diff --git a/docs/Backend&Coordinator/Backend.md b/docs/Backend&Coordinator/Backend.md new file mode 100644 index 0000000000..18303ace59 --- /dev/null +++ b/docs/Backend&Coordinator/Backend.md @@ -0,0 +1,8 @@ +--- +{ + "title": "Backend", + "description": "Insert description" +} +--- + +# Backend \ No newline at end of file diff --git a/docs/Backend&Coordinator/Coordinator.md b/docs/Backend&Coordinator/Coordinator.md new file mode 100644 index 0000000000..6fb949fc2c --- /dev/null +++ b/docs/Backend&Coordinator/Coordinator.md @@ -0,0 +1,8 @@ +--- +{ + "title": "Coordinator", + "description": "Insert description" +} +--- + +# Coordinator \ No newline at end of file diff --git a/docs/Backend&Coordinator/README.md b/docs/Backend&Coordinator/README.md new file mode 100644 index 0000000000..835a21ed93 --- /dev/null +++ b/docs/Backend&Coordinator/README.md @@ -0,0 +1,25 @@ +--- +{ + "title": "Backend & Coordinator", + "description": "All the information for those Wasabikas interested in helping Wasabi Wallet users by running a backend and/or a coordinator. This is the Wasabi documentation, an archive of knowledge about the open-source, non-custodial and privacy-focused Bitcoin wallet for desktop." +} +--- + +# Backend & Coordinator + +This is the place with documentation about how a Wasabi backend and coordinator work and how they can be run. + +A backend is necessary for Wasabi users to synchronize their wallet. + +A coordinator is necessary for Wasabi users to be able to coinjoin. + +## Chapters + +### Backend + +- [Backend](/Backend&Coordinator/Backend.md) + +### Coordinator + +- [Coordinator](/Backend&Coordinator/Coordinator.md) +