Write user guide #91
Comments
Based on instructions at: - https://github.com/asciidoctor/asciidoctor-gradle-plugin#installation With the following as "hello world" Asciidoc content: - https://gist.github.com/mojavelinux/9a8d3f1d32a8f0656a42 Usage: - Run `./gradlew asciidoc` - Open `build/asciidoc/hello.html` See #91
In preparation for work on #91, remove no longer referenced screenshots that are, in many cases out of date anyway.
Use source and output dirs named 'docs' vs. the default 'asciidoc'. See #91
- Port instructions for building from source from Markdown to Asciidoc - Make these instructions one section in a larger 'developer guide' document. Done for symmetry with the user guide forthcoming in #91.
- Assign ":revnumber:" header attribute using the {project-version}
attribute automatically passed into asciidoctor by the Gradle plugin.
- Also configure headings to render with numbers using the ":numbered:"
header attribute.
See #91
Based on instructions at: - https://github.com/asciidoctor/asciidoctor-gradle-plugin#installation With the following as "hello world" Asciidoc content: - https://gist.github.com/mojavelinux/9a8d3f1d32a8f0656a42 Usage: - Run `./gradlew asciidoc` - Open `build/asciidoc/hello.html` See #91
In preparation for work on #91, remove no longer referenced screenshots that are, in many cases out of date anyway.
Use source and output dirs named 'docs' vs. the default 'asciidoc'. See #91
- Port instructions for building from source from Markdown to Asciidoc - Make these instructions one section in a larger 'developer guide' document. Done for symmetry with the user guide forthcoming in #91.
- Assign ":revnumber:" header attribute using the {project-version}
attribute automatically passed into asciidoctor by the Gradle plugin.
- Also configure headings to render with numbers using the ":numbered:"
header attribute.
See #91
|
@ManfredKarrer, @bitsquare/core-team: I'd like to discuss exactly what we need to have in the user guide for the 0.1 release. The original approach I had been taking (at https://docs.bitsquare.io/0.1.0-SNAPSHOT/userguide/) is probably too ambitious... it certainly didn't work to try to explain how to bring up two instances locally, etc... but we've come a long way since then. Let's try to outline the bare essentials here: I think that
Are probably good to keep We should include something about enabling UPnP and how to set up manual port forwarding. Maybe in a "Troubleshooting" section? We should include something that explains to the user that Bitsquare is testnet-only right now, and that the only use case implemented is placing an offer to buy bitcoin and then taking an offer to buy bitcoin. We should also explain that arbitration and account registration are not yet implemented / disabled at the moment, but that they'll be coming in future milestones. We should include the roadmap, or a link to it. Basically, we should communicate that Bitsquare 0.1 is a proof of concept that allows early users to test drive the process of buying bitcoin on testnet, and get a sense of where we're trying to go with the project, so they can provide feedback. What else would you like to see (or change from the above)? |
|
@cbeams Can we postpone that a bit after the crowd funding preparation is done (Lighthouse). I think we might also reconsider the IRC model we use atm. But lets move it to next week if its ok for you? |
|
For the moment the user guide in GH wiki should be enough. Will close that for now. |
userguidebranchUPDATE: see https://github.com/bitsquare/bitsquare/wiki/User-Guide
The text was updated successfully, but these errors were encountered: