diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index ec1b8a37..7787f9cb 100644 --- a/docs/_data/navigation.yml +++ b/docs/_data/navigation.yml @@ -18,31 +18,48 @@ docs: url: /docs/tor/ - title: "    Access" url: /docs/access/ - - - title: " Best Practices" - url: /docs/best-practices/ - children: - - title: "    PGP Encryption" - url: /docs/pgp-encryption/ - - title: "    Payment Methods" - url: /docs/fiat-payment-methods/ - - title: "    Proxy Wallets" - url: /docs/proxy-wallet/ - - title: "    Lightning Channels" - url: /docs/channels/ - title: " Features" url: /docs/features/ children: - title: "    Private" - url: /docs/privacy/ - - title: "      Bonds & Escrow" - url: /docs/bonds-escrow/ + url: /docs/private/ + - title: "    Fast" + url: /docs/fast/ + - title: "     Bonds & Escrow" + url: /docs/safe/ + + - title: " Understand" + url: /docs/understand/ + children: + - title: "    Trade Pipeline" + url: /docs/trade-pipeline/ + - title: "    Premium" + url: /docs/premium/ + - title: "    Bonds" + url: /docs/bonds/ + - title: "    Trade Escrow" + url: /docs/trade-escrow/ + - title: "    Disputes" + url: /docs/disputes/ + - title: "    Wallets" + url: /docs/wallets/ + - title: "    Limits" + url: /docs/limits/ - title: "    Swaps" url: /docs/swaps/ - - title: " Wallets" - url: /docs/wallets/ + - title: " Best Practices" + url: /docs/best-practices/ + children: + - title: "    PGP Encryption" + url: /docs/pgp-encryption/ + - title: "    Payment Methods" + url: /docs/fiat-payment-best-practices/ + - title: "    Proxy Wallets" + url: /docs/proxy-wallet/ + - title: "    Lightning Channels" + url: /docs/channels/ tutorial: - title: " Watch" diff --git a/docs/_includes/feature_row b/docs/_includes/feature_row index 0fa7de74..ce263df0 100644 --- a/docs/_includes/feature_row +++ b/docs/_includes/feature_row @@ -18,7 +18,7 @@ {% endif %} {% endif %} -
+
{% if f.title %}

{{ f.title }}

@@ -34,7 +34,7 @@

{{ f.btn_label | default: site.data.ui-text[site.locale].more_label | default: "Learn More" }}

{% endif %}
-
+ {% endfor %} diff --git a/docs/_includes/improve b/docs/_includes/improve index eeede644..79cc3385 100644 --- a/docs/_includes/improve +++ b/docs/_includes/improve @@ -1,6 +1,6 @@ ## You can help improve this page! -Learn RoboSats is a joint effort of the RoboSats community. +Learn RoboSats is a joint effort of the RoboSats community. If you have used RoboSats before, you are already an expert! Help improve this documentation. -**ProTip:** You can directly edit [the content of this page ](https://github.com/Reckless-Satoshi/robosats/blob/main/docs/{{page.src}}) and open a [Pull Request ](https://github.com/Reckless-Satoshi/robosats/pulls), your changes will show right here. +**ProTip:** You can directly edit [this page ](https://github.com/Reckless-Satoshi/robosats/blob/main/docs/{{page.src}}) and open a [Pull Request ](https://github.com/Reckless-Satoshi/robosats/pulls). Your changes will show right here. {: .notice--primary} \ No newline at end of file diff --git a/docs/_pages/docs/00-quick-start/00-quicks-start-guide.md b/docs/_pages/docs/00-quick-start/00-quicks-start-guide.md index 6198ed08..07df3c48 100644 --- a/docs/_pages/docs/00-quick-start/00-quicks-start-guide.md +++ b/docs/_pages/docs/00-quick-start/00-quicks-start-guide.md @@ -6,4 +6,12 @@ sidebar: title: " Quick Start" nav: docs --- -To start exchanging Bitcoin with RoboSats securily and privately you only need two things: a lightning wallet and a web browser that supports TOR. \ No newline at end of file +RoboSats is an easy way to privately exchange Bitcoin for national currencies. It simplifies the peer-to-peer experience and makes use lightning hold invoices to minimize custody and trust requirements. The deterministically generated avatars help users stick to best privacy practices. + +**Let's go!** To start using RoboSats you only need two things: a [ Lightning Wallet](/docs/wallets/) and a [TOR enabled Web Browser](/docs/tor/). +{: .notice--primary} + +1. Get a Lightning enabled Wallet +2. Get Tor Browser +3. Access RoboSats +4. Watch and read simple tutorials \ No newline at end of file diff --git a/docs/_pages/docs/01-best-practices/01-PGP-guide.md b/docs/_pages/docs/01-best-practices/01-PGP-guide.md index 5ed458ff..68821138 100644 --- a/docs/_pages/docs/01-best-practices/01-PGP-guide.md +++ b/docs/_pages/docs/01-best-practices/01-PGP-guide.md @@ -7,8 +7,8 @@ toc_sticky: true sidebar: title: " Easy PGP Encryption" nav: docs ---- - +src: "_pages/docs/01-best-practices/01-PGP-guide.md" +--- Learn how to use OpenKeychain to cipher sensible data during RoboSats trade. ## Why encryption is needed? @@ -94,3 +94,4 @@ Once the seller has the buyer's public key, the encryption schema show above can The encrypted data must be copied including the header `(-----BEGIN PGP MESSAGE-----)` and footer `(-----END PGP MESSAGE-----)` for the correct operation of the application. If the buyer obtains interpretable data, it means that the exchange has been successful and the confidentiality of the data is assured since the only key that can decrypt it is the private key of the buyer. If you would like to read more easily crafted tutorial on how to use OpenKeychain for general purposes check [As Easy as P,G,P](https://diverter.hostyourown.tools/as-easy-as-pgp/) +{% include improve %} \ No newline at end of file diff --git a/docs/_pages/docs/01-best-practices/01-PGP-guide_es.md b/docs/_pages/docs/01-best-practices/01-PGP-guide_es.md index 06b2b17d..f3cf0cc7 100644 --- a/docs/_pages/docs/01-best-practices/01-PGP-guide_es.md +++ b/docs/_pages/docs/01-best-practices/01-PGP-guide_es.md @@ -7,7 +7,9 @@ toc_sticky: true sidebar: title: " Fácil Encriptación PGP" nav: docs ---- +src: "_pages/docs/01-best-practices/01-PGP-guide_es.md" +--- + Cómo usar OpenKeychain para cifrar datos sensibles al usar RoboSats. ## ¿Por qué es necesaria la encriptación? @@ -81,3 +83,5 @@ Una vez que el vendedor tiene la clave pública del comprador, se puede aplicar Los datos cifrados deben copiarse incluyendo el encabezado `(-----BEGIN PGP MESSAGE-----)` y el pie de página `(-----END PGP MESSAGE-----)` para el funcionamiento correcto de la aplicación. Si el comprador visualiza correctamente en la app los datos del vendedor significa que el intercambio ha sido exitoso y la confidencialidad de los datos está asegurada ya que la única clave que puede descifrarlos es la clave privada del comprador. Si quieres leer un tutorial sobre cómo usar OpenKeychain para uso general, consulta [As Easy as P,G,P](https://diverter.hostyourown.tools/as-easy-as-pgp/) + +{% include improve %} \ No newline at end of file diff --git a/docs/_pages/docs/02-features/private.md b/docs/_pages/docs/02-features/01-private.md similarity index 100% rename from docs/_pages/docs/02-features/private.md rename to docs/_pages/docs/02-features/01-private.md diff --git a/docs/_pages/docs/02-features/02-tor.md b/docs/_pages/docs/02-features/02-tor.md new file mode 100644 index 00000000..b63f8303 --- /dev/null +++ b/docs/_pages/docs/02-features/02-tor.md @@ -0,0 +1,10 @@ +--- +layout: single +title: "The TOR Network" +permalink: /docs/tor/ +sidebar: + title: " TOR" + nav: docs +src: "_pages/docs/00-quick-start/02-tor.md" +--- +{% include wip %} \ No newline at end of file diff --git a/docs/_pages/docs/03-understand/01-trade-pipeline.md b/docs/_pages/docs/03-understand/01-trade-pipeline.md new file mode 100644 index 00000000..94cd27fe --- /dev/null +++ b/docs/_pages/docs/03-understand/01-trade-pipeline.md @@ -0,0 +1,28 @@ +--- +layout: single +classes: wide +title: "Trade Pipeline" +permalink: /docs/trade-pipeline/ +sidebar: + title: " Trade Pipeline" + nav: docs +src: "_pages/docs/03-understand/01-trade-pipeline.md" +--- + +Alice wants to buy Sats privately. This is step-by-step what happens when she buys using RoboSats. + + +1. Alice generates an avatar (AdequateAlice01) using her private random token. +2. Alice stores safely the token in case she needs to recover AdequateAlice01 in the future. +3. Alice makes a new order and locks a small hold invoice to publish it (maker bond). +4. Bob wants to sell satoshis, sees Alice's order in the book and takes it. +5. Bob scans a small hold invoice as his taker bond. The contract is final. +6. Bob posts the traded satoshis with a hold invoice. While Alice submits her payout invoice. +7. On a private chat, Bob tells Alice how to send him fiat. +8. Alice pays Bob, then they confirm the fiat has been sent and received. +9. Bob's trade hold invoice is charged and the satoshis are sent to Alice. +10. Bob and Alice's bonds return automatically, since they complied by the rules. +11. The bonds would be charged (lost) in case of unilateral cancellation or cheating (lost dispute). + + +{% include improve %} \ No newline at end of file diff --git a/docs/_pages/docs/03-wallets.md b/docs/_pages/docs/03-understand/06-wallets.md similarity index 97% rename from docs/_pages/docs/03-wallets.md rename to docs/_pages/docs/03-understand/06-wallets.md index 3950c51a..76e67d8d 100644 --- a/docs/_pages/docs/03-wallets.md +++ b/docs/_pages/docs/03-understand/06-wallets.md @@ -71,5 +71,5 @@ The hodl invoice shows as a grey icon while waiting. Need to tap the back obviou ## Help keep this page updated -There are many wallets and all of them keep improving at lightning speed. You can contribute to the RoboSats Open Source Project by testing wallets, editing [the content of this page](https://github.com/Reckless-Satoshi/robosats/tree/main/docs/_pages/wallets.md) and opening a [Pull Request](https://github.com/Reckless-Satoshi/robosats/pulls) +There are many wallets and all of them keep improving at lightning speed. You can contribute to the RoboSats Open Source Project by testing wallets, editing [the content of this page](https://github.com/Reckless-Satoshi/robosats/tree/main/docs/_pages/docs/03-understand/06-wallets.md) and opening a [Pull Request](https://github.com/Reckless-Satoshi/robosats/pulls) diff --git a/docs/_sass/minimal-mistakes/_notices.scss b/docs/_sass/minimal-mistakes/_notices.scss index 3a9b5e60..0381fb1f 100644 --- a/docs/_sass/minimal-mistakes/_notices.scss +++ b/docs/_sass/minimal-mistakes/_notices.scss @@ -80,6 +80,17 @@ @include notice($primary-color); } +.notice--primary-light { + @include notice($primary-light-color); +} + +/* Secondary notice */ + +.notice--secondary { + @include notice($secondary-color); +} + + /* Info notice */ .notice--info { diff --git a/docs/_sass/minimal-mistakes/skins/_robosats.scss b/docs/_sass/minimal-mistakes/skins/_robosats.scss index f62f4d09..b2a98c31 100644 --- a/docs/_sass/minimal-mistakes/skins/_robosats.scss +++ b/docs/_sass/minimal-mistakes/skins/_robosats.scss @@ -7,12 +7,12 @@ $background-color: #ffffff !default; $text-color: #2c2c2c !default; $muted-text-color: #393e46 !default; $primary-color: #1976d2 !default; -$primary-color-light: #42a5f5 !default; -$primary-color-dark: #1565c0 !default; +$primary-light-color: #42a5f5 !default; +$primary-dark-color: #1565c0 !default; $secondary-color: #9c27b0 !default; $border-color: mix(#fff, #393e46, 75%) !default; $footer-background-color: $primary-color !default; -$link-color: $primary-color-light !default; +$link-color: $primary-light-color !default; $masthead-link-color: $text-color !default; $masthead-link-color-hover: $primary-color !default; $navicon-link-color-hover: mix(#fff, $text-color, 80%) !default; @@ -22,7 +22,7 @@ $warning-color : #ed6c02 !default; $danger-color : #d32f2f !default; $info-color : #0288d1 !default; -$notice-background-mix: 50% !default; +$notice-background-mix: 70% !default; .page__footer { color: #fff !important; // override diff --git a/docs/assets/images/misc/feature-open-source.png b/docs/assets/images/misc/feature-open-source.png index 8898f17c..4b607d61 100644 Binary files a/docs/assets/images/misc/feature-open-source.png and b/docs/assets/images/misc/feature-open-source.png differ diff --git a/docs/home.md b/docs/home.md index 9b35d74d..0ca010cf 100644 --- a/docs/home.md +++ b/docs/home.md @@ -12,21 +12,21 @@ feature_row: - image_path: /assets/images/misc/feature-fast.png alt: "fast" title: "Lightning Fast" - excerpt: "Exchanging P2P has never been faster!
LN Hodl invoices serve as bonds & escrows for high assurance and speed. A trade can happen faster than then next block is mined!" - url: "/docs/lightning-features/" + excerpt: "Exchanging P2P has never been faster!
LN Hodl invoices serve as bonds & escrows for high assurance and speed. From start to finish before the next block is mined!" + url: "/docs/fast/" btn_class: "btn--primary" btn_label: "Learn more" - image_path: /assets/images/misc/feature-private.png alt: "private" title: "Absolutely Private" - excerpt: "Best privacy practice by default.
Simple and KYC-free. You will generate a random Robot avatar for a single use. The exchange is Tor-only.
" - url: "/docs/privacy-features/" + excerpt: "Best privacy practices by default.
Simple and KYC-free. You will generate a random Robot avatar for a single use. The exchange is Tor-only.
" + url: "/docs/private/" btn_class: "btn--primary" btn_label: "Learn more" - image_path: /assets/images/misc/feature-open-source.png alt: "FLOSS" title: "Open Source" - excerpt: 'RoboSats is fully open source and will always be. Built by Robots just like you!{::nomarkdown}

{:/nomarkdown}' + excerpt: 'RoboSats is fully open source and will always be. Built by Robots just like you!{::nomarkdown}

{:/nomarkdown}' url: "https://github.com/Reckless-Satoshi/robosats/blob/main/LICENSE" btn_class: "btn--primary" btn_label: "See License"