Documentation

  • Resolved ThemeAWESOME

    (@tsquez)


    7 years ago

    Hi there,

    Just curious as to when the “Documentation” is going to be completed.

    The reason I ask is, sometimes I go and have a look to figure something out and I get a page with nothing on it but:

    The documentation site is currently being rewritten. If you can’t find what you’re looking for please check the github issues and ask for assistance there until the documentation rewrite is complete.

    So then I have to use the “The Internet Wayback machine” and view information. Gets a little frustrating sometimes. I know your busy and such, so I was just curious is all.

    Thanks again for all you do.

Viewing 4 replies - 1 through 4 (of 4 total)

  • If you’re looking for a doc that is not there yet then please create a specific issue for that in the github repository.
    I regularly go through the feature requests & suggestions there and add docs as they are requested.
    If I don’t see people requesting for docs then I assume that they don’t have issues and work on improving the plugin, bugfixes, new implementations etc. It’s just a matter of prioritizing. If nobody asks for them then they are not my highest priority ??

    gordo019

    (@gordo019)

    Just wanted to second the documentation request and hopefully with example code.

    I totally agree with both of you. Better and more complete docs are needed. So next time you’re looking for something that you can’t find, please open a ticket on GitHub and I’ll add docs accordingly. If there’s a specific request like “i was looking for documentation on how to do task Y and couldn’t find it” then docs will be added for that task.
    What will not happen though is me going on a documentation frenzy, going through all pages, adding stuff that I think are missing etc. I’ve done that in the past and wasted a lot of time documenting things that nobody was using.
    Also worth mentioning, the documentation is just a docs folder in the repository: https://github.com/aristath/kirki/tree/develop/docs/docs
    Contributing to them is easy and on every page there’s an edit link at the bottom that lets you make suggestions and pull requests.

    Thread Starter ThemeAWESOME

    (@tsquez)

    I understand about not going into a doc frenzy…lol I have to add more docs to my theme but it is slow going especially when I’m focused on the theme.

Viewing 4 replies - 1 through 4 (of 4 total)
  • The topic ‘Documentation’ is closed to new replies.