Skip to content

Commit

Permalink
create Backend and Coordinator docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MarnixCroes committed Sep 16, 2024
1 parent fc9b203 commit 857511b
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
13 changes: 13 additions & 0 deletions docs/.vuepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,9 @@ export default defineUserConfig({
}, {
text: "FAQ",
link: "/FAQ/"
}, {
text: "Backend & Coordinator",
link: "/backend&coordinator/"
}, {
text: "Glossary",
link: "/glossary/"
Expand Down Expand Up @@ -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,
Expand Down
8 changes: 8 additions & 0 deletions docs/Backend&Coordinator/Backend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
{
"title": "Backend",
"description": "Insert description"
}
---

# Backend
8 changes: 8 additions & 0 deletions docs/Backend&Coordinator/Coordinator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
{
"title": "Coordinator",
"description": "Insert description"
}
---

# Coordinator
25 changes: 25 additions & 0 deletions docs/Backend&Coordinator/README.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 857511b

Please sign in to comment.