Documentation

Discussion in 'Requests for Proposals' started by jy-p, Jan 17, 2017.

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

    jcv Full Member
    Developer

    That would be https://w3c.github.io/webappsec-subresource-integrity/ Not sure if all browsers implement it or not but I don't think we could do it with mkdocs anyway.
     
  2. jcv

    jcv Full Member
    Developer

    Yeah, I noticed those two as well. I opened an issue about it and plan on fixing it if no one else gets to it first.
     
  3. jrick

    jrick Member
    Developer

    Jan 4, 2016
    88
    81
    Male
  4. Fyber

    Fyber New Member

    Feb 3, 2017
    1
    1
    Male
    USA
    I'm interested in doing documentation. I don't yet fully understand the project, so a great way for me to learn more is to write documentation! I already noticed many differences from current documentation to the latest versions of decred.

    In order to contribute, should I be doing a fork > pull request type thing, or is there another way?
     
    jy-p likes this.
  5. jcv

    jcv Full Member
    Developer

    We do the fork/pr thing. I've got a document that goes over the way we handle code/contributions and so on:

    https://gist.github.com/jcvernaleo/aa3f6c216f3df1f9c6b62d7f59a2a469
     
  6. jy-p

    jy-p Sr. Member
    Organizer

    Jan 2, 2016
    133
    340
    Male
    If you're interested in doing documentation work, give it a go on GitHub, per the guide jcv linked. Provided you're capable and willing to do the work, we can talk about a contract after you've participated for a bit.
     
  7. jet

    jet New Member

    Jan 29, 2017
    84
    16
    Web
  8. jcv

    jcv Full Member
    Developer

    On the wiki issue, I'd love for someone to go through the wiki page by page and either open issues for anything on it that is missing for dcrdocs or even better open a PR adding the content. That way we could be sure we migrate everything and then I'd like to just get rid of the wiki since it is just not used. I don't remember anyone actually objecting to killing it once we know all is moved (but if someone does object, not would be a good time).
     
  9. Shadowlance

    Shadowlance Full Member

    Jan 9, 2016
    220
    155
    Male
    It's on my to-do list. I'll ad it to github.
     
  10. jcv

    jcv Full Member
    Developer

    I'm definitely looking forward to the docs being in one place.
     
  11. RandaFlores

    RandaFlores New Member

    Apr 23, 2019
    32
    0
    Female
    London
    Will your screen be clean? If the process of cleaning here is necessary, there are so many ways to make sure of this. And this is one of the best variants here.
     

Share This Page