Requests For Updates To Documentation

Discussion in 'Questions' started by Shadowlance, Jan 25, 2017.

  1. 2017/12/15 - Decred v1.1.2 released! → Release Notes  → Downloads
  1. Shadowlance

    Shadowlance Full Member

    Jan 9, 2016
    220
    155
    Male
    #1 Shadowlance, Jan 25, 2017
    Last edited: Jan 26, 2017
    Hi all,

    I am pleased to say that I have once again taken up the mantle for looking after the documentation going forward. The current docs were written almost a year ago now and are missing a lot of information on major updates such as the GUI wallets, ticket buyer and new and improved features.

    I'm going to go through what's currently there and dust it off a bit but I want to know what the community thinks needs to be added/changed. So far I have the following list:
    • GUI wallets.
    • Dcrinstall.
    • Ticket buyer how-to.
    • Explanation of how ticket fees are calculated.
    • Third party tools page to showcase completed stuff that's currently in the User Projects forum.
    • Update docs for CLI tools. Lots of new options now.
    • Single entry point for new users (aka Golden Path).
    • Update FAQ with VERY basic info such as how to send and receive Decred.
    That's on top of removing out of date info (if you see any, let me know). If there's anything else you'd like to see added, post it here.

    Shadowlance
     
    Jazzah, jy-p, David and 1 other person like this.
  2. davecgh

    davecgh Hero Member
    Developer Organizer

    Dec 31, 2015
    642
    788
    Male
    United States
    Awesome. I'm glad to see you're working on getting them updated. They definitely need it.
     
  3. MiloIce

    MiloIce Jr. Member

    Jan 18, 2016
    206
    26
    Male
    Hi @Shadowlance , if possible, would you be able to make videos on GUI Wallet/Dcrinstall? I think it would be easier if most people can follow a video guide.

    Thanks for the work!
     
  4. Shadowlance

    Shadowlance Full Member

    Jan 9, 2016
    220
    155
    Male
    That's not a bad idea. I personally prefer text with images since I can go through it at my own pace, but I know a lot of people like video walk throughs. I'll see what we can do. It will be after 0.8.0 though since a lot will change in that release.
     
    MiloIce likes this.
  5. jcv

    jcv Full Member
    Developer

    I kind of hate video walk throughs, but if some people find them useful, then I guess we should have one at some point.

    One thing I think our docs really need is a bit more interconnection. What I mean is that if you start from the github README for a project you'll likely never find the docs site. The wiki may or may not connect to anytihng else. And so on. I think it would be good if the various docs actually pointed to each other in a hopefully logical way.
     
    Jazzah likes this.
  6. jrick

    jrick Member
    Developer

    Jan 4, 2016
    88
    81
    Male
    So who's writing the manpages? :)
     
  7. davecgh

    davecgh Hero Member
    Developer Organizer

    Dec 31, 2015
    642
    788
    Male
    United States
    I generally prefer written doco too (easier to copy/paste for one thing), but I know a ton of people that find it much easier to follow a video. I'm not really sure why that's true, but it is nonetheless, so I think it's a good idea to provide them.
     
  8. jcv

    jcv Full Member
    Developer

    Don't get me started on how much I hate the anti-man page attitude of the go community. It is as bad as the GNU folks and their info pages.
     
  9. jrick

    jrick Member
    Developer

    Jan 4, 2016
    88
    81
    Male
    We could still do it if there's enough interest. As part of my toying around with SmartOS recently I discovered that some of their base tooling (e.g. vmadm) is written in node, and yet they still provide manpages for them.
     
  10. gratefulcheddar

    gratefulcheddar New Member

    Jan 9, 2017
    12
    5
    Male
    CS Student
    IL
  11. jcv

    jcv Full Member
    Developer

    Great. Very happy to see all those issue opened. I commented on a few and hopefully others will chime in. If you want any of the issues assigned to one of you two, just comment in the issue or pm me and I can assign it.
     
  12. jy-p

    jy-p Sr. Member
    Organizer

    Jan 2, 2016
    133
    340
    Male
    manpages would certainly be nice, but the onboarding-related work is the low-hanging fruit.

    file an issue in each repo :)
     

Share This Page