diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index 65d42c84..ec1b8a37 100644 --- a/docs/_data/navigation.yml +++ b/docs/_data/navigation.yml @@ -62,3 +62,22 @@ tutorial: - title: "    Deutsch" url: "/read/de/" +contribute: + - title: " Contribute" + url: /contribute/ + children: + - title: "    Code" + url: /contribute/code/ + - title: "    Translations" + url: /contribute/languages/ + - title: "    LN liquidity" + url: /contribute/liquidity/ + - title: "    Guides" + url: /contribute/guides/ + - title: "    Art" + url: /contribute/art/ + - title: "    Outreach" + url: /contribute/outreach/ + - title: "    Donate" + url: /contribute/funding/ + diff --git a/docs/_includes/feature_row b/docs/_includes/feature_row index 03f09c15..0fa7de74 100644 --- a/docs/_includes/feature_row +++ b/docs/_includes/feature_row @@ -18,7 +18,7 @@ {% endif %} {% endif %} - +
{% if f.title %}

{{ f.title }}

@@ -34,6 +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 a3dc1c9f..eeede644 100644 --- a/docs/_includes/improve +++ b/docs/_includes/improve @@ -1,6 +1,6 @@ -### You can help improve this page! +## 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. **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. {: .notice--primary} \ No newline at end of file diff --git a/docs/_includes/wip b/docs/_includes/wip index 234b8ae8..73c46c9e 100644 --- a/docs/_includes/wip +++ b/docs/_includes/wip @@ -1,11 +1,13 @@ +
+
This page is under construction. Learn.RoboSats is a joint effort of the RoboSats community. -### You can complete this page! +## You can complete this page! **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. {: .notice--primary} diff --git a/docs/_pages/contribute/00-contribute.md b/docs/_pages/contribute/00-contribute.md index e69de29b..2b446ce4 100644 --- a/docs/_pages/contribute/00-contribute.md +++ b/docs/_pages/contribute/00-contribute.md @@ -0,0 +1,21 @@ +--- +layout: single +title: "Contribute" +permalink: /contribute/ +sidebar: + title: " Contribute" + nav: contribute +src: "_pages/contribute/00-contribute.md" +--- + +You can help RoboSats get better: + +1. [Development](/contribute/code/) +2. [Translations](/contribute/languages/) +3. [Lightning liquidity](/contribute/liquidity/) +4. [Guides and video-tutorials](/contribute/guides/) +5. [Art](/contribute/art/) +6. [Tell someone](/contribute/outreach/) +7. [Donate](/contribute/funding/) + +{% include wip %} \ No newline at end of file diff --git a/docs/_pages/contribute/01-development.md b/docs/_pages/contribute/01-development.md index e69de29b..d26cf84f 100644 --- a/docs/_pages/contribute/01-development.md +++ b/docs/_pages/contribute/01-development.md @@ -0,0 +1,100 @@ +--- +layout: single +title: "Develop RoboSats" +permalink: /contribute/code/ +sidebar: + title: " Code" + nav: contribute +toc: true +toc_sticky: true +src: "_pages/contribute/01-development.md" +--- + +Everyone can contribute to the development of the Robotic Satoshis Open Source Project. If you're looking for somewhere to start contributing, check out the [good first issue](https://github.com/reckless-satoshi/robosats/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue") list. + + +This contributing guide is based on the [Bisq contributing guide](https://github.com/bisq-network/bisq/blob/master/CONTRIBUTING.md). While the scope and complexity of RoboSats is more manageable, following best practices is free. + +## Communication Channels + +Most communication about RoboSats happens on the main Telegram group. However public community driven support is available in other languages. +* EN [t.me/robosats](https://t.me/robosats) (main) +* ES [t.me/robosats_es](https://t.me/robosats_es) +* RU [t.me/robosats_ru](https://t.me/robosats_ru) +* PT [t.me/robosats_pt](https://t.me/robosats_pt) +* CN [t.me/robosats_cn](https://t.me/robosats_cn) + +Discussion about code changes happens in GitHub issues and pull requests. + + +## Contributor Workflow + +All RoboSats contributors submit changes via pull requests. The workflow is as follows: + + - Fork the repository + - Create a topic branch from the `main` branch + - Commit patches + - Squash redundant or unnecessary commits + - Submit a pull request from your topic branch back to the `main` branch of the main repository + - Make changes to the pull request if reviewers request them and request a re-review + +Pull requests should be focused on a single change. Do not mix, for example, refactorings with a bug fix or implementation of a new feature. This practice makes it easier for fellow contributors to review each pull request. + + +## Reviewing Pull Requests + +Robosats follows the review workflow established by the Bitcoin Core project. The following is adapted from the [Bitcoin Core contributor documentation](https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#peer-review): + +Anyone may participate in peer review which is expressed by comments in the pull request. Typically reviewers will review the code for obvious errors, as well as test out the patch set and opine on the technical merits of the patch. Project maintainers take into account the peer review when determining if there is consensus to merge a pull request (remember that discussions may have been spread out over GitHub and Telegram). The following language is used within pull-request comments: + + - `ACK` means "I have tested the code and I agree it should be merged"; + - `NACK` means "I disagree this should be merged", and must be accompanied by sound technical justification. NACKs without accompanying reasoning may be disregarded; + - `utACK` means "I have not tested the code, but I have reviewed it and it looks OK, I agree it can be merged"; + - `Concept ACK` means "I agree in the general principle of this pull request"; + - `Nit` refers to trivial, often non-blocking issues. + +Please note that Pull Requests marked `NACK` and/or GitHub's `Change requested` are closed after 30 days if not addressed. + +## Developer Compensation (Pilot Program) + +At the moment RoboSats is a young and unfunded project. However, since launch, it has shown the ability to generate revenue, although it barely covers the running costs. A developer compensation program is the the best way to ensure the sustained support of the code base. For the time being, code contributions to the core project will be given small rewards: more akin to kudos than a meaningful monetary compensation. The pilot procedure for compensated development: + +1. The developer opens a PR with the description of the work that will be done, optionally including the amount of Sats he thinks the work deserves. +2. An offer/negotiation takes place to set an amount of Sats until agreement. Everyone is welcome to express opinion on whether the compensation is right for the PR. +3. The work happens: buidl, buidl, buidl! +4. The review takes place. Once maintainers give the OK for the merge... +5. The developer submits a LN invoice (with a long expiration time). The invoice is paid at merge. + +Every step (negotiation, code submission, review and invoice submission) must take place publicly in GitHub (i.e., no private messaging). Please contact the team lead for development (@reckless-satoshi) upfront if you have doubts whether your contribution is suitable for compensation. Currently, only contributions to the frontend or backend core functionality and maintainence are eligible for compensations (that excludes, for the time being, art, translations, etc...). + +## Style and Coding Conventions + +### Configure Git user name and email metadata + +See https://help.github.com/articles/setting-your-username-in-git/ for instructions. + +### Write well-formed commit messages + +From https://chris.beams.io/posts/git-commit/#seven-rules: + + 1. Separate subject from body with a blank line + 2. Limit the subject line to 50 characters (*) + 3. Capitalize the subject line + 4. Do not end the subject line with a period + 5. Use the imperative mood in the subject line + 6. Wrap the body at 72 characters (*) + 7. Use the body to explain what and why vs. how + + +### Sign your commits with GPG + +See https://github.com/blog/2144-gpg-signature-verification for background and +https://help.github.com/articles/signing-commits-with-gpg/ for instructions. + +### Use an editor that supports Editorconfig + +The [.editorconfig](.editorconfig) settings in this repository ensure consistent management of whitespace. Most modern editors support it natively or with plugin. See http://editorconfig.org for details. + +### Keep the git history clean + +It's very important to keep the git history clear, light and easily browsable. This means contributors must make sure their pull requests include only meaningful commits (if they are redundant or were added after a review, they should be removed) and _no merge commits_. \ No newline at end of file diff --git a/docs/_pages/contribute/02-translations.md b/docs/_pages/contribute/02-translations.md index e69de29b..9354fd77 100644 --- a/docs/_pages/contribute/02-translations.md +++ b/docs/_pages/contribute/02-translations.md @@ -0,0 +1,12 @@ +--- +layout: single +title: "Translate RoboSats" +permalink: /contribute/languages/ +sidebar: + title: " Translation" + nav: contribute +toc: true +toc_sticky: true +src: "_pages/contribute/02-translations.md" +--- +{% include wip %} \ No newline at end of file diff --git a/docs/_pages/docs/00-quick-start/03-access.md b/docs/_pages/docs/00-quick-start/03-access.md index 7e8deb97..43959627 100644 --- a/docs/_pages/docs/00-quick-start/03-access.md +++ b/docs/_pages/docs/00-quick-start/03-access.md @@ -27,9 +27,11 @@ Take it for granted: if you use that link, you are being spied on. However, most In order to more easily remember how to access, we have set up robosats.com . If you are using Tor Browser, it will directly take you to the Onion Site. Otherwise, it will take you to the unsafe site. -> [robosats.com](https://robosats.com) +> [robosats.com](https://robosats.com) -#### Testnet + +## Others +### Testnet You can practice and test all of the functionalities in RoboSats without of losing funds by using [Testnet Bitcoin](https://en.bitcoin.it/wiki/Testnet). All you need is a Testnet Lightning wallet and access the testnet platform > [robotestagw3dcxmd66r4rgksb4nmmr43fh7
7bzn2ia2eucduyeafnyd.onion](http://robotestagw3dcxmd66r4rgksb4nmmr43fh77bzn2ia2eucduyeafnyd.onion/) @@ -38,7 +40,7 @@ Or unsafely on the testnet clearnet bridge. > [unsafe.testnet.robosats.com](http://unsafe.testnet.robosats.com) -#### Clearnet Mirrors +### Clearnet Mirrors There are several tor2web services that serve as mirrors in case one of them is unavailable > [unsafe.robosats.com](https://unsafe.robosats.com/)
diff --git a/docs/assets/images/misc/feature-fast.png b/docs/assets/images/misc/feature-fast.png index 2b538174..1495dc38 100644 Binary files a/docs/assets/images/misc/feature-fast.png and b/docs/assets/images/misc/feature-fast.png differ diff --git a/docs/assets/images/misc/feature-open-source.png b/docs/assets/images/misc/feature-open-source.png index 4eae0e44..8898f17c 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/assets/images/misc/feature-private.png b/docs/assets/images/misc/feature-private.png index 000694ca..073f422d 100644 Binary files a/docs/assets/images/misc/feature-private.png and b/docs/assets/images/misc/feature-private.png differ diff --git a/docs/assets/images/misc/learn-robosats-home.png b/docs/assets/images/misc/learn-robosats-home.png index 9577bca5..43fcbe69 100644 Binary files a/docs/assets/images/misc/learn-robosats-home.png and b/docs/assets/images/misc/learn-robosats-home.png differ diff --git a/docs/home.md b/docs/home.md index 6d4b572f..9b35d74d 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: "TODO... lightning... hodl... faster than a block....Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore" + 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/" btn_class: "btn--primary" btn_label: "Learn more" - image_path: /assets/images/misc/feature-private.png alt: "private" title: "Absolutely Private" - excerpt: "TODO... Strong privacy by default. No KYC, no ID, no email, no number needed... Tor Only...no pseudonymous reuse....Lorem ipsum dolor sit amet
" + 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/" 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.{::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" diff --git a/frontend/src/components/Dialogs/Learn.tsx b/frontend/src/components/Dialogs/Learn.tsx index ae808978..e1814c38 100644 --- a/frontend/src/components/Dialogs/Learn.tsx +++ b/frontend/src/components/Dialogs/Learn.tsx @@ -27,12 +27,12 @@ const LearnDialog = ({ onClose={onClose} > - {t("Tutorials and Documentation")} + {t("Learn RoboSats")} - {t("You are about to visit 'Learn.RoboSats' page. This is a community built site hosting tutorials and documentation to help you learn to use RoboSats and understand how it works.")} + {t("You are about to visit Learn RoboSats. It hosts tutorials and documentation to help you learn how to use RoboSats and understand how it works.")} diff --git a/frontend/src/locales/en.json b/frontend/src/locales/en.json index 47fb664e..df891cc3 100644 --- a/frontend/src/locales/en.json +++ b/frontend/src/locales/en.json @@ -18,8 +18,8 @@ "Make Order":"Make Order", "Info":"Info", "View Book":"View Book", - "Tutorials and Documentation":"Tutorials and Documentation", - "You are about to visit 'Learn.RoboSats' page. This is a community built site hosting tutorials and documentation to help you learn to use RoboSats and understand how it works.":"You are about to visit 'Learn.RoboSats' page. This is a community built site hosting tutorials and documentation to help you learn to use RoboSats and understand how it works.", + "Learn RoboSats":"Learn RoboSats", + "You are about to visit Learn RoboSats. It hosts tutorials and documentation to help you learn how to use RoboSats and understand how it works.":"You are about to visit Learn RoboSats. It hosts tutorials and documentation to help you learn how to use RoboSats and understand how it works.", "Let's go!":"Let's go!", diff --git a/frontend/src/locales/es.json b/frontend/src/locales/es.json index 827d2f0c..82a6ca3c 100644 --- a/frontend/src/locales/es.json +++ b/frontend/src/locales/es.json @@ -18,8 +18,8 @@ "Make Order":"Crear orden", "Info": "Info", "View Book": "Ver libro", - "Tutorials and Documentation":"Tutoriales y Documentación", - "You are about to visit 'Learn.RoboSats' page. This is a community built site hosting tutorials and documentation to help you learn to use RoboSats and understand how it works.":"Vas a visitar la página 'Learn.RoboSats'. Ha sido construida por la comunidad y tiene tutoriales y documentación que te ayudará a aprender como se usa RoboSats y a entender como funciona.", + "Learn RoboSats":"Aprende RoboSats", + "You are about to visit Learn RoboSats. It hosts tutorials and documentation to help you learn how to use RoboSats and understand how it works.":"Vas a visitar la página Learn RoboSats. Ha sido construida por la comunidad y contiene tutoriales y documentación que te ayudará a aprender como se usa RoboSats y a entender como funciona.", "Let's go!":"¡Vamos!",