We launched new forums in March 2019—join us there. In a hurry for help with your website? Get Help Now!
    • 10525
    • 247 Posts
    Mark, many thanks for that. I'll try to keep an eye on, and use, that github repo too. Some interesting things there.
      • 10525
      • 247 Posts
      Another thing I think would be useful feature in the docs is a "knowledge dependencies" list.

      With Extras, or any other code class/package, people need to know which other extras/classes/packages are required for them to work. This idea is pretty well established.

      Similarly, when working with MODx, users need to know which languages, technologies etc they need to be familiar/proficient/expert in in order to carry out what is described in the docs. A good example is this blog post, in which it is pointed our relatively early on that knowledge os sass is required: https://modx.com/blog/2014/07/11/manager-theme-introduction/ (although I can't actually find any Sass in my MODX files).

      If we could have a standardised list at the top of each docs page, or the sections within it, showing what you need to know, that would be a real help, eg:

      HTML:
      CSS:
      PHP:
      Javascript:
      SQL:
      Sass:
      etc..

      This might also act as a helpful guide to illustrate the complexity of working with MODx and what can and cannot be done by newcomers. If these were added as tags to docs pages (along with MODx version numbers), it would make filtering the docs even more useful.

      As I suggested above (https://forums.modx.com/thread/99534/modx-docs-issues-particularly-with-search#dis-post-538345), draft docs could be created by MODX devs. If they have a blank doc template, with guidelines and fields for summary, aims, methods, examples, etc, a tickable list of knowledge requirements would be easy for them to do.