Feature #8163
Write user documentation for Electrum
100%
Description
We might want to get inspiration from, or link to one of these:
- https://electrum.org/tutorials.html: Very bare bone tutorial (but see last paragraph).
- http://bitzuma.com/posts/a-beginners-guide-to-the-electrum-bitcoin-wallet/: Very verbose, and uses screenshots extensively. It starts with an “Installation” part, but the HTML document has anchors for each section, which makes it easier to link to specific parts we feel are relevant.
Subtasks
History
#1 Updated by anonym 2015-01-23 13:52:20
Gentle ping, since writing the user docs is the only thing blocking electrum from inclusion. sajolida, do you think you’ll have time to get this ready in time for Tails 1.3 (the feature freeze is currently 2015-02-11)?
#2 Updated by sajolida 2015-01-23 21:57:52
Yes, I think that I’ll make it. I have lots of tickets for 1.3 but right now I try to focus on the coding ones, then I’ll tackle the documentation ones. I’ll have some quality working time the week before the freeze so that should work.
#3 Updated by Tails 2015-02-01 11:02:29
- Status changed from Confirmed to In Progress
Applied in changeset commit:f23fa32ebdd9efbd7de147b9e7bd1a86bae7ac0c.
#4 Updated by sajolida 2015-02-01 11:08:12
- Assignee changed from sajolida to anonym
- QA Check changed from Dev Needed to Ready for QA
Mostly done in 0869606. Please have a look.
#5 Updated by BitingBird 2015-02-01 14:19:38
I think it’s pretty good, but maybe you should mention to first enable the persistence option, then reboot before starting electrum?
And maybe put a link to https://en.wikipedia.org/wiki/Bitcoin (not sure, but might be a good idea).
#6 Updated by anonym 2015-02-01 15:26:02
sajolida wrote:
> Mostly done in 0869606. Please have a look.
Thanks! I’ll have a closer look later this week. However, I cannot merge the branch since it contains my code, which some one else has to review.
BitingBird wrote:
> I think it’s pretty good, but maybe you should mention to first enable the persistence option, then reboot before starting electrum?
Note that my implementation adds a wrapper around electrum that checks whether its persistence preset is enabled, and warns the user if it isn’t.
> And maybe put a link to https://en.wikipedia.org/wiki/Bitcoin (not sure, but might be a good idea).
Indeed, the first instance of “bitcoin”, perhaps?
#7 Updated by sajolida 2015-02-02 21:22:50
Done in 2253b48.
#8 Updated by BitingBird 2015-02-05 02:51:58
- % Done changed from 0 to 50
#9 Updated by anonym 2015-02-10 11:06:04
- Status changed from In Progress to Resolved
- Assignee deleted (
anonym) - QA Check changed from Ready for QA to Pass
#10 Updated by anonym 2015-02-10 11:06:36
- % Done changed from 50 to 100
#11 Updated by sajolida 2015-02-18 11:53:49
- Status changed from Resolved to Confirmed
- QA Check changed from Pass to Dev Needed
- Feature Branch set to feature/6739-install-electrum
I’m not sure whether this is the correct procedure. But we’ve been submitted to improvements to the documentation see 2ba009a and 4e69220.
I still want to rephrase them a bit before asking for a new review and merge in time for 1.3.
#12 Updated by intrigeri 2015-02-18 12:15:32
- Status changed from Confirmed to In Progress
- Assignee set to sajolida
- % Done changed from 100 to 70
#13 Updated by sajolida 2015-02-21 13:40:48
- Assignee deleted (
sajolida) - QA Check changed from Dev Needed to Ready for QA
That’s ready for review now, see 2ba009a..fb2f6f0.
#14 Updated by sajolida 2015-02-23 09:33:58
I added some more commits today, see 5c3061d..27f8f68.
#15 Updated by anonym 2015-02-23 15:29:19
- Status changed from In Progress to Fix committed
- % Done changed from 70 to 100
- QA Check changed from Ready for QA to Pass
Merged! I think it looks very good, and certainly better than without those warnings/tips.
#16 Updated by BitingBird 2015-02-24 22:48:13
- Status changed from Fix committed to Resolved