refactor(docs): move source for doc pages here (#119)

* docs: move dev docs to dev-docs folder

* docs: move source for doc pages here

* docs: improve docs
This commit is contained in:
Einliterflasche 2024-10-25 03:55:18 +02:00 committed by GitHub
parent 5341587dfa
commit bfc82c0534
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
46 changed files with 6307 additions and 0 deletions

View file

@ -0,0 +1,57 @@
@startuml
package "User Host" {
component [Monero Wallet RPC\n(auto installed)] as CliMonRpc
() RPC as MonRpcCli
component "swap" {
component [CLI] as CLI
component [Bitcoin Wallet] as CliBitWal
}
CliMonRpc - MonRpcCli
CLI - CliBitWal
MonRpcCli - CLI
}
package "Public Monero Server" {
component "monerod" as Monerod
}
package "Public Bitcoin Server" {
component "Electrum Server" as Electrum
component "bitcoind" as Bitcoind
() "RPC" as BitRPC
BitRPC -- Electrum
Electrum - Bitcoind
}
package "Service Provider Host" {
component [Monero Wallet RPC] as AsbMonRpc
() RPC as MonRpcAsb
component "asb" {
component [ASB] as ASB
component [Bitcoin Wallet] as AsbBitWal
}
AsbMonRpc - MonRpcAsb
ASB - AsbBitWal
MonRpcAsb - ASB
}
package "Public Price Server" {
component [CEX Price Ticker] as CEX
() "websocket" as Ticker
Ticker - CEX
Ticker -- ASB
}
CliBitWal -- BitRPC
CliMonRpc -- Monerod
AsbMonRpc -- Monerod
AsbBitWal -- BitRPC
() "libp2p" as Libp2p
Libp2p -- CLI
ASB -- Libp2p
footer XMR<>BTC swap CLI & ASB overview (public nodes)\nRendered with PlantUML version %version()
@enduml

View file

@ -0,0 +1,67 @@
@startuml
package "User Host" {
component [Monero Wallet RPC\n(auto installed)] as CliMonRpc
() RPC as MonRpcCli
component "swap" {
component [CLI] as CLI
component [Bitcoin Wallet] as CliBitWal
}
CliMonRpc - MonRpcCli
CLI - CliBitWal
MonRpcCli - CLI
}
package "Public Monero Server" {
component "monerod" as Monerod
}
package "Public Bitcoin Server" {
component "Electrum Server" as Electrum
component "bitcoind" as Bitcoind
() "RPC" as BitRPC
BitRPC -- Electrum
Electrum - Bitcoind
}
package "Service Provider Host" {
component [Monero Wallet RPC] as AsbMonRpc
() RPC as MonRpcAsb
component "asb" {
component [ASB] as ASB
component [Bitcoin Wallet] as AsbBitWal
}
AsbMonRpc - MonRpcAsb
component "monerod" as AsbMonerod
component "Electrum Server" as AsbElectrum
component "bitcoind" as AsbBitcoind
AsbMonRpc -- AsbMonerod
() "RPC" as AsbBitRPC
AsbBitWal -- AsbBitRPC
AsbBitRPC -- AsbElectrum
AsbElectrum - AsbBitcoind
ASB - AsbBitWal
ASB -- MonRpcAsb
}
package "Public Price Server" {
component [CEX Price Ticker] as CEX
() "websocket" as Ticker
Ticker - CEX
Ticker -- ASB
}
CliBitWal -- BitRPC
CliMonRpc -- Monerod
() "libp2p" as Libp2p
Libp2p -- CLI
ASB -- Libp2p
footer XMR<>BTC swap CLI & ASB overview\nRendered with PlantUML version %version()
@enduml

View file

@ -0,0 +1,34 @@
@startuml
package "Service Provider 1" {
rectangle CLI as cli01
rectangle CLI as cli02
rectangle CLI as cli03
rectangle ASB as asb01
note right of asb01
Service provider
advertising to
multiple users.
end note
cli01 -> asb01
cli02 --> asb01
asb01 <-- cli03
}
package "Service Provider 2" {
rectangle CLI as cli04
rectangle ASB as asb02
note right of asb02
Service provider
advertising to
one single users.
end note
cli04 -> asb02
}
@enduml