diff --git a/README.md b/README.md index aaa3323f..7964f117 100644 --- a/README.md +++ b/README.md @@ -25,11 +25,11 @@ RoboSats is a simple and private way to exchange bitcoin for national currencies ## How to use it -- **[Full Walkthrough how to use RoboSats (English)](https://github.com/Reckless-Satoshi/robosats/blob/main/docs/how-to-use.md)** +- **[Full Walkthrough how to use RoboSats (English)](https://github.com/Reckless-Satoshi/robosats/tree/main/docs/_pages/tutorials/read/how-to-use.md)** -- **[Guia completa de como usar RoboSats (Español)](https://github.com/Reckless-Satoshi/robosats/blob/main/docs/how-to-use_es.md)** +- **[Guia completa de como usar RoboSats (Español)](https://github.com/Reckless-Satoshi/robosats/tree/main/docs/_pages/tutorials/read/how-to-use_es.md)** -- **[Vollständiges how to use RoboSats (German)](https://github.com/Reckless-Satoshi/robosats/blob/main/docs/how-to-use_de.md)** +- **[Vollständiges how to use RoboSats (German)](https://github.com/Reckless-Satoshi/robosats/tree/main/docs/_pages/tutorials/read/how-to-use_de.md)** **Short video-walktrough** diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index 2e262a33..c60c16c4 100644 --- a/docs/_data/navigation.yml +++ b/docs/_data/navigation.yml @@ -50,6 +50,8 @@ docs: url: /docs/limits/ - title: "    Swaps" url: /docs/swaps/ + - title: "    Telegram" + url: /docs/telegram/ - title: " Best Practices" url: /docs/best-practices/ diff --git a/docs/_includes/add_tutorials b/docs/_includes/add_tutorials index 1dae700c..55821772 100644 --- a/docs/_includes/add_tutorials +++ b/docs/_includes/add_tutorials @@ -1,6 +1,6 @@ -## You can create and add here more tutorials +## You can add here more tutorials -Learn RoboSats is a joint effort of the RoboSats community. If you have used RoboSats before, you are already an expert! Help us build more and better tutorials in all languages. +Learn RoboSats is a joint effort of the RoboSats community. If you have used RoboSats before, you are already an expert! Help us build more and better tutorials in every language. **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/contribute/07-donate.md b/docs/_pages/contribute/07-donate.md index fd08afb2..45035764 100644 --- a/docs/_pages/contribute/07-donate.md +++ b/docs/_pages/contribute/07-donate.md @@ -3,9 +3,18 @@ layout: single title: "Donate" permalink: /contribute/donate/ sidebar: - title: " Donate" + title: " Donate" nav: contribute src: "_pages/contribute/07-donate.md" --- + + {% include wip %} \ No newline at end of file diff --git a/docs/_pages/docs/03-understand/07-wallets.md b/docs/_pages/docs/03-understand/07-wallets.md index 04a596c8..dc950668 100644 --- a/docs/_pages/docs/03-understand/07-wallets.md +++ b/docs/_pages/docs/03-understand/07-wallets.md @@ -23,6 +23,7 @@ thumbsdown: "" bitcoin: "" --- +This is a non-exhaustive compilation based on past experience of users. We have not tested every wallet, if you test a wallet that is not yet covered, please [report here](https://github.com/Reckless-Satoshi/robosats/issues/44). | Wallet | Version | Device | UX1 | Bonds2 | Payout3 | Comp4 | Total5 | |:---|:---|:--:|:--:|:--:|:--:|:--:|:--:| diff --git a/docs/_pages/docs/03-understand/10-telegram.md b/docs/_pages/docs/03-understand/10-telegram.md new file mode 100644 index 00000000..7db770de --- /dev/null +++ b/docs/_pages/docs/03-understand/10-telegram.md @@ -0,0 +1,13 @@ +--- +layout: single +title: Telegram Notifications, Alert and Groups +permalink: /docs/telegram/ +sidebar: + title: " Telegram" + nav: docs +src: "_pages/docs/03-understand/10-telegram.md" +--- + + + +{% include wip %} \ No newline at end of file diff --git a/docs/_posts/2022-05-14-welcome-to-learn-robosats.md b/docs/_posts/2022-05-19-welcome-to-learn-robosats.md similarity index 94% rename from docs/_posts/2022-05-14-welcome-to-learn-robosats.md rename to docs/_posts/2022-05-19-welcome-to-learn-robosats.md index e9babc5f..7e616d2e 100644 --- a/docs/_posts/2022-05-14-welcome-to-learn-robosats.md +++ b/docs/_posts/2022-05-19-welcome-to-learn-robosats.md @@ -2,7 +2,7 @@ layout: home author_profile: true title: "Welcome to Learn.RoboSats!" -date: 2022-05-19 06:28:14 -0500 +date: 2022-05-18 06:28:14 -0500 categories: robosats update --- Sovereignty is scary at first, then liberating. Buying your first Sats from a peer might seem intimidating, but it is very empowering. In Learn.RoboSats you can find all of the documentation and resources so you feel comfortable using the RoboSats P2P exchange. From easy to follow video tutorials, to technical deep-dives into how the exchange works. diff --git a/setup.md b/setup.md index ccd8788b..88af2bd4 100644 --- a/setup.md +++ b/setup.md @@ -19,19 +19,24 @@ Running the full stack is not easy, since RoboSats needs of many services. Howev 4 - On another terminal `npm install -g http-server` -5 - Then run `http-server "robosats/frontend/static/frontend/` +5 - Then run `http-server "robosats/frontend/static/` 6 - Install [Requestly](https://requestly.io/) extension in your browser, it's a lightweight proxy. We want to use it so our browser grabs our local `main.js` instead of the remote. There are many alternatives to Requestly (be aware that Requestly might not respect your privacy. Didn't research it). 7 - Pick a RoboSats backend to test the new frontend: e.g. "robosats.onion.moe", or "unsafe.testnet.robosats.com". You can also use the onion services also if you are using Brave or Tor Browser (untested!) -8 - Open Requestly extension and add a new redirect rule. Make "{robosats-site}/static/frontend/main.js" redirect to "127.0.0.1:8080/main.js" and save the changes. +8 - Open Requestly extension and add a new redirect rule. Make "{robosats-site}/static/frontend/main.js" redirect to "127.0.0.1:8080/frontend/main.js" and save the changes. ------------------- **You are ready to go!** Edit the frontend code in `/frontend/src/` to make the changes you want. Within a few seconds, the `npm run dev` process will pack the code into the local `main.js`. Visit your selected {robosats-site} and you will see your new awesome frontend! :) -Every time you save changes to files in `/frontend/src` you will be able to see them in your browser after a few seconds using force refresh (Ctrl+Shift+R). If you need to edit CSS or other static files, simply add them to Requestly in the same way. +Every time you save changes to files in `/frontend/src` you will be able to see them in your browser after a few seconds using force refresh (Ctrl+Shift+R). + +If you need to edit CSS or other static files in `/frontend/static`, simply add them to Requestly in the same way. + +i.e: index.css +Make "{robosats-site}/static/css/index.css" redirect to "127.0.0.1:8080/css/index.css" # Full Stack Development ## The Easy Way: Docker-compose (-dev containers running on testnet)