We launched new forums in March 2019—join us there. In a hurry for help with your website? Get Help Now!
    • 14646
    • 8 Posts
    Yep, there's definitely proof out there that this can work. Documentation system built on GitHub repos built on .md documents.

    I'll try and do a proof of concept project this weekend.

    Quote from: sottwell at Mar 10, 2014, 06:09 AM

    The developers of SimpleCart and pdoTools have a documentation project up that I've used when submitting English documentation for some of the pdoTools snippets. It is integrated with a github respository, and uses the .md files.

    http://docs.modx.pro/en/
    https://github.com/bezumkin/Docs
      Jonathan Haslett
      Director at https://dash.marketing/
      MODX Slack @jonathanhaslett
      • 39404
      • 175 Posts
      stalemate resolution associate Reply #42, 10 years, 1 month ago
      I was just surfing the forums, and saw this thread for the first time. Based on something I saw at MODXpo, it looks like some places do up documentation as part of the project so that it lives on the same site as what is handed over (or maybe a separate site).

      I wonder if it makes sense to have an Extra that has non-technical documentation (modxmanual.com is amazing btw) that can be installed and customized as part of the project? Word works well enough of course, but it tends to live in people's email boxes, or printed on people's desks which gets reprinted a bunch of times when something gets changed.

      Regards,
      Tom
        • 27106
        • 147 Posts
        Another possibility would be to simply make it a Google Docs document to which certain editors had access and which the public could download or adapt as they want. Thoughts?
          David Walker
          Principal, Shorewalker DMS
          Phone: 03 8899 7790
          Mobile: 0407 133 020