diff --git a/contributor-checklist.adoc b/contributor-checklist.adoc index 44b5bd7..3eb4f85 100644 --- a/contributor-checklist.adoc +++ b/contributor-checklist.adoc @@ -1,4 +1,6 @@ -= New Contributor Checklist += 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. @@ -18,9 +20,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). 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 26c7983..0558d21 100644 --- a/index.adoc +++ b/index.adoc @@ -1,24 +1,70 @@ = Bisq Network Documentation +:toc: left +:sectanchors: +:docinfo: private - * *_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 +[TIP] +.Brand new to Bisq? +==== +Welcome! Start with the <>. You'll be up and trading quickly. +==== - * *_Contributor Docs_* - ** <> - ** <> - ** <> - ** <> - ** <> - ** <> +[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, <>. +==== - * *_Papers_* - ** <> +== User Docs - * *_Specifications_* - ** <> - ** <> - ** https://docs.google.com/document/d/1DXEVEfk4x1qN6QgIcb2PjZwU4m7W6ib49wCdktMMjLw/edit#heading=h.4nbd0q1s77uq[Bisq arbitration and mediation system] (GDoc) +=== 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 https://bisq.network/faq/#paymentmethods[20+] supported fiat currency payment methods, from Alipay to Zelle_ + * Altcoins — _Explore https://bisq.network/faq/#altcoins[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 https://twitter.com/bisq_network/status/946723541298360320[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 + + * <> + * <> + * <> + * <> + * <> + * <> + +== Papers + + * <> + +== Specifications + + * <> + * <> + * https://docs.google.com/document/d/1DXEVEfk4x1qN6QgIcb2PjZwU4m7W6ib49wCdktMMjLw/edit#heading=h.4nbd0q1s77uq[Bisq arbitration and mediation system] (GDoc) + +== Archive + + * <> diff --git a/intro.adoc b/intro.adoc index 87b5ee4..3e42305 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"]