MODx: powerful project for powerful brains. thank you and goodbye.

Susan,

I too know that MODx is not that hard to learn but it takes time to master (I’m still on the road with a long way to go). I have few criticisms of MODx and all of them will be quelled once we hit 1.0. except for the documentation.

Yes the information is mostly there and I have gotten past blaming snippet contribs for not creating award winning documentation as they spend time creating great enhancements to MODx. Those of us who can learn and share can help improve documentation as we learn ourselves and get even more experience as we go.

This thread is a fine example of why MODx is so great--community that communicates and shares.

The documentation is getting a lot better; however, sometimes it is a little hard to find. For instance, I the documentation for Ditto is absolutely amazing:

http://ditto.modxcms.com/

Quote from: jesster444 at Sep 10, 2007, 10:04 AM

...the documentation for Ditto is absolutely amazing:

http://ditto.modxcms.com/

@jesster444, Yes the docs are getting better and better. I think that the wiki will be killer soon.

The ditto docs are very detailed and contain a lot of information and I would love that every large snippet contain such detail BUT volume of information can lead to an exponential increase in learning curve. I have only recently dug into Ditto but actually found the documentation heavy on code rationale and light on usage. This is not the writers’ fault as he has provided extremely detailed outlining of the the elements that may be controlled and the like but what I and I suspect others learn most from are real-world examples. In my experience it is nice to see documentation start with a description, sample call and then delve into parameters, templates and placeholders.

This is where the wiki comes in. I am currently working on two larger (yet unposted) wiki docs and I would love to see more user contribution to the Wiki--after all that is what it is for. Users to share solutions, information , documentation and examples of real-world examples of code usage. The main documentation understandably won’t be revised until the team gets over the 0.9.7 to 1.0 hump of converting the codebase to xPDO.

All the best,

Jay

Until then, ANYone who has had a success, or has solved a problem in the forums should feel encouraged to post to the Wiki and tell others.

Quote from: smashingred at Sep 10, 2007, 10:25 AM

The main documentation understandably won’t be revised until the team gets over the 0.9.7 to 1.0 hump of converting the codebase to xPDO.

Just to let you know - MODx 0.9.7 will be fully xPDO. 1.0 changes will be different than the database ORM and structure.

Thanks, that was a type-faster-than-thinks error.

I was trying to say that the main documentation likely won’t be updated until major changes are done to the MODx core so that it won’t have to be done more than once. Since I am not on the dev team I don’t know when this will occur and I am only basing that on what Ryan and Jason have posted here and there on the forums.

Cheers,

Jay

Quote from: smashingred at Sep 10, 2007, 11:11 AM

Thanks, that was a type-faster-than-thinks error.

I was trying to say that the main documentation likely won’t be updated until major changes are done to the MODx core so that it won’t have to be done more than once. Since I am not on the dev team I don’t know when this will occur and I am only basing that on what Ryan and Jason have posted here and there on the forums.

Based on what we’ve done so far, I’d say after the 0.9.7 release, you’ll start to see a lot more documentation happen. A lot of the core structure/database work is happening in 0.9.7, which will make some of the current documentation obsolete. However, I don’t forsee too much needing to be rewritten for the 0.9.7 -> 1.0 release.

I’d be willing to say (and Jason and Ryan can chip in as well) that docs will be much better post-097.

That is what I gathered from their posts relating to 0.9.7. Thanks for the confirmation though.