From d724d8060ac287d4f2b2db9277d7bcf46366916c Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Mon, 28 May 2018 17:46:42 +0200 Subject: [PATCH 1/8] Restructure from bullets to 2nd-level headings --- index.adoc | 44 ++++++++++++++++++++++++++------------------ 1 file changed, 26 insertions(+), 18 deletions(-) diff --git a/index.adoc b/index.adoc index 26c7983..59bef3b 100644 --- a/index.adoc +++ b/index.adoc @@ -1,24 +1,32 @@ = Bisq Network Documentation +:toc: left +:sectanchors: - * *_User Docs_* - ** <> — Learn what Bisq is, why it exists and how it works - ** <> — Go from zero to trading in 15 minutes - ** <> — Keep your bitcoin safe +== User Docs - * *_Contributor Docs_* - ** <> - ** <> - ** <> - ** <> - ** <> - ** <> + * <> — Learn what Bisq is, why it exists and how it works + * <> — Go from zero to trading in 15 minutes + * <> — Keep your bitcoin safe - * *_Papers_* - ** <> +== Contributor Docs - * *_Specifications_* - ** <> - ** <> - ** https://docs.google.com/document/d/1DXEVEfk4x1qN6QgIcb2PjZwU4m7W6ib49wCdktMMjLw/edit#heading=h.4nbd0q1s77uq[Bisq arbitration and mediation system] (GDoc) + * <> + * <> + * <> + * <> + * <> + * <> - * *_<>_* +== Papers + + * <> + +== Specifications + + * <> + * <> + * https://docs.google.com/document/d/1DXEVEfk4x1qN6QgIcb2PjZwU4m7W6ib49wCdktMMjLw/edit#heading=h.4nbd0q1s77uq[Bisq arbitration and mediation system] (GDoc) + +== Archive + + * <> From 912bfd4496b8befef195a08bf060dba12e4eccb5 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Wed, 30 May 2018 09:14:33 +0200 Subject: [PATCH 2/8] Refine GitHub-related contributor checklist items --- contributor-checklist.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/contributor-checklist.adoc b/contributor-checklist.adoc index 44b5bd7..4fb1778 100644 --- a/contributor-checklist.adoc +++ b/contributor-checklist.adoc @@ -1,4 +1,4 @@ -= New Contributor Checklist += Contributor Checklist So you're interested in contributing to Bisq--welcome! This checklist will get you plugged in and productive quickly as possible. @@ -18,9 +18,9 @@ This can mean anything from fixing typos in documentation, to answering question * [ ] Introduce yourself in the `#general` channel. Say a bit about your skills and interests. This will help others point you in the right direction. - * [ ] Join the `#github` channel and request an invite to the https://github.com/bisq-network[@bisq-network] organization. An admin will get you set up. Doing this makes it possible to assign you to GitHub issues. + * [ ] Join the `#github` channel and request an invite to the https://github.com/bisq-network[@bisq-network] organization. An admin will get you set up. Doing this makes it possible to add you to the https://github.com/orgs/bisq-network/teams/contributors[@bisq-network/contributors] team and to assign you to GitHub issues. - * [ ] After accepting your GitHub invitation, consider changing your https://github.com/orgs/bisq-network/people[membership visibility] from private to public. This helps others know at a glance roughly how many contributors are involved with Bisq. + * [ ] After accepting your GitHub invitation, please change your https://github.com/orgs/bisq-network/people[membership visibility] from `private` to `public`. This helps others know at a glance roughly how many contributors are involved with Bisq. * [ ] Explore the other channels in Slack, and join the ones that are of interest to you. For a start, we recommend joining `#proposals`, `#roles`, `#compensation`, and `#dev` (if you're a developer). From bcf7489ec21650651bfcfc8501f1231e55d8aba0 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Wed, 30 May 2018 09:15:33 +0200 Subject: [PATCH 3/8] Add ToC to intro doc for navigational consistency --- intro.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/intro.adoc b/intro.adoc index 092666a..ab2fba8 100644 --- a/intro.adoc +++ b/intro.adoc @@ -1,4 +1,5 @@ = A Brief Introduction to Bisq +:toc: left :sectanchors: video::Fv-eCchzBZA[youtube,start=113,end=1168,width=860,height=480,options="modest"] From be25270fbcf9db8244891ac50f9b83a478568a0d Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Wed, 30 May 2018 09:18:29 +0200 Subject: [PATCH 4/8] Add private docinfo file for index page This docinfo file is empty to avoid adding the "Back to index" link found in the default `docinfo-footer.html` file. See https://asciidoctor.org/docs/user-manual/#naming-docinfo-files for details on how all this works. --- index-docinfo-footer.html | 0 index.adoc | 1 + 2 files changed, 1 insertion(+) create mode 100644 index-docinfo-footer.html diff --git a/index-docinfo-footer.html b/index-docinfo-footer.html new file mode 100644 index 0000000..e69de29 diff --git a/index.adoc b/index.adoc index 59bef3b..106915c 100644 --- a/index.adoc +++ b/index.adoc @@ -1,6 +1,7 @@ = Bisq Network Documentation :toc: left :sectanchors: +:docinfo: private == User Docs From 4ce35b69f4a5ac4a56caff3fe7328484afd810f9 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Wed, 30 May 2018 10:09:24 +0200 Subject: [PATCH 5/8] Add ToC to contributor-checklist for nav consistency --- contributor-checklist.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/contributor-checklist.adoc b/contributor-checklist.adoc index 4fb1778..3eb4f85 100644 --- a/contributor-checklist.adoc +++ b/contributor-checklist.adoc @@ -1,4 +1,6 @@ = Contributor Checklist +:toc: left +:sectanchors: So you're interested in contributing to Bisq--welcome! This checklist will get you plugged in and productive quickly as possible. From 07f85b475a342bd704c6a86a5c9fa683c5778d7b Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Wed, 30 May 2018 10:11:30 +0200 Subject: [PATCH 6/8] Flesh out 'User Docs' section of index page As explained in the new admonition at the top of the page, many of these docs have not yet been written, and therefore have no links. The idea is to publish this list of the docs we have _and_ the docs we want to have, such that users can get a sense of everything we want them to know about Bisq, even though it's not all ready to go yet, and such that contributors can get a sense of where they can add value by writing these incomplete docs. In subsequent commits, the same kind of 'fleshing out' will be done for the 'Contributor Docs' section of the index page. --- index.adoc | 45 +++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 41 insertions(+), 4 deletions(-) diff --git a/index.adoc b/index.adoc index 106915c..b8ab9b2 100644 --- a/index.adoc +++ b/index.adoc @@ -3,15 +3,52 @@ :sectanchors: :docinfo: private +[TIP] +.Brand new to Bisq? +==== +Welcome! Start with the <>. You'll be up and trading quickly. +==== + +[NOTE] +.These docs are a work in progress (and you can help) +==== +Docs without hyperlinks haven't been written yet. If you want to write one, <>. +==== + == User Docs - * <> — Learn what Bisq is, why it exists and how it works - * <> — Go from zero to trading in 15 minutes - * <> — Keep your bitcoin safe +=== Essentials + + * <> — _Learn what Bisq is, why it exists and how it works_ + * <> — _Download, set up and start trading with Bisq in minutes_ + * <> — _Set a password and save your seed words to keep your bitcoin safe_ + * Backup and Recovery — _Maintain backups to keep your settings and history safe_ + * Staying Private — _Maximize control over your personal info and trading data_ + * Trading and Arbitration Rules — _Know what's expected of you and others when trading_ + * Fees and Security Deposits - _Understand how your bitcoin is used and kept safe when trading_ + * Support — _Get help from other Bisq users and contributors_ + +=== Features + + * Payment Methods — _Explore 20+ supported fiat currency payment methods, from Alipay to Zelle_ + * Altcoins — _Explore 100+ supported cryptocurrencies, tokens and assets_ + +=== Ecosystem + + * News and Announcements – _Stay informed with the Bisq https://github.com/bisq-network/proposals/issues/20[mailing list], https://twitter.com/bisq_network[Twitter], https://www.youtube.com/c/bisq-network[YouTube], https://www.facebook.com/bisqnetwork/[Facebook], etc_ + * Media and Press — _Catch up on talks, interviews, podcasts and articles about Bisq_ + * Chat and Discussion — _Connect with other users on the Bisq https://bisq.community[Forum], https://bisq.network/slack-invite[Slack], https://webchat.freenode.net/?channels=bisq[IRC], https://keybase.io/team/bisq[Keybase], etc_ + * Charts and Data – _Explore Bisq https://markets.bisq.network[markets], https://bisq.network/volume[global volume], https://coin.dance/volume/bisq/[regional volume], https://bisq.network/release-stats[release statistics], etc_ + * Ratings and Reviews — _Read Bisq user experience reports and reviews on sites like https://www.cryptocompare.com/exchanges/bisq/[CryptoCompare]_ + +=== Incubating Efforts + + * Bisq HTTP API — _Automate trading and interact programmatically with your Bisq node_ + * Bisq Mobile — _Operate your Bisq node remotely via a web/mobile frontend_ == Contributor Docs - * <> + * <> * <> * <> * <> From 193942c89d928b98c0cb9294e2fed6b0ebddf14f Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Fri, 8 Jun 2018 08:48:44 +0200 Subject: [PATCH 7/8] Link to altcoin/payment method section of FAQ As as stopgap measure until proper docs are written. See https://github.com/bisq-network/bisq-docs/pull/60#issuecomment-393106543 for context. --- index.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/index.adoc b/index.adoc index b8ab9b2..6acf91a 100644 --- a/index.adoc +++ b/index.adoc @@ -30,8 +30,8 @@ Docs without hyperlinks haven't been written yet. If you want to write one, < Date: Fri, 8 Jun 2018 08:48:44 +0200 Subject: [PATCH 8/8] Link to Twitter thread with talks, podcasts etc Like the previous commit, this is a stopgap measure until a proper doc is written to capture these resources. --- index.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.adoc b/index.adoc index 6acf91a..0558d21 100644 --- a/index.adoc +++ b/index.adoc @@ -36,7 +36,7 @@ Docs without hyperlinks haven't been written yet. If you want to write one, <