This repository has been archived by the owner on Jun 15, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 81
Produce a Getting Started Guide #37
Comments
Initial PR coming today, still tracking to have this done in early May (i.e., within a few days). Got a few questions, will follow up on Slack. |
This was referenced May 3, 2018
Closing as complete with the merge of #45. From https://docs.bisq.network/getting-started.html: |
I've promoted this work with https://twitter.com/bisq_network/status/1001086255277531136: |
cbeams
added a commit
to cbeams/bisq-docs
that referenced
this issue
May 29, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
There is already a placeholder link for this guide at https://docs.bisq.network, pointing to https://docs.bisq.network/getting-started.html.
This doc should cover the following essential steps required to get up and trading with Bisq:
This is of course just the very highest-level outline possible, and there will be things to discuss and decisions to make about how to present each of the bullet points above.
In general, the guide should walk step-by-step through a single, focused use case, and not do a lot of branching into the various options available at each of the bullet points above. For example, in the "Complete your first trade" section, there are four options: the user can (1) make an offer to buy bitcoin, (2) take an offer to buy bitcoin, (3) make an offer to sell bitcoin or (4) take an offer to sell bitcoin. Rather than detail all four (and lose the reader), we should stay focused and detail just one: how to take an offer to buy bitcoin (because this is the easiest and fastest thing for a brand new user to do). We can do sidebars and admonitions to inform the user that the other options exist, though, and as we have more materials available that go into detail about them, we can link to them.
There is also the question of what operating system(s) we should address or focus on in the guide. Like the notes above, I believe we should stay focused and only show instructions and screenshots for one OS (at least for now). Our download statistics tell us that most users are on Windows, but even with that being true, I think we should focus this guide on the Mac. This is for a couple reasons: the first is convenience and practicality, as the author of this guide will probably themselves be using a Mac, and I don't want them to be burdened on this first cut with getting Windows screenshots; the second reason is basically "optics"—the document will simply look and feel better if it's filled with macOS images than if it's filled with Windows images. With that said, though, most screenshots are of the Bisq JavaFX UI, which is essentially the same across all platforms. The only really OS-specific screenshots and instructions are around downloading and installing, and I'm not sure how much we need to spell that out anyway. We writing for a reasonably tech-savvy audience still at this point; I'm not sure we need to document and screenshot the process of downloading and installing from a
.dmg
.@m52go plans to begin work on this doc (thus my assigning it to him), and plans to "be his own audience" as he walks through his own first trades with with Bisq.
The first deliverable, then, will be a more detailed outline that we can review. It's fine to iterate on that outline in Slack and in the comments below for now, @m52go, or you can already start working in Asciidoc in your own fork of the repo if you prefer. See https://github.com/bisq-network/bisq-docs#readme for instructions on how to get up and running.
The text was updated successfully, but these errors were encountered: