What would you like to see more Documentation on?

We’re currently working on the official documentation for MODx Revolution 2.0.0, found here:

http://svn.modxcms.com/docs/display/revolution/MODx+Revolution

As we approach beta2 very shortly, we’re trying to get the documentation up to par. So that’s where we’d like to ask you, the community, for guidance and help:

(Note: this excludes Security, as we are aware of a lack of docs there and are working on documentation for it.)

1. What would you like to see more of in the Revolution documentation - ie, what should be documented more? What’s some areas we can concentrate on?

2. Would you like to contribute to Revolution documentation? Let us know.

I think the top priority is API documentation. Make it more accessible, readable. One of the good solution for example is CakePHP

Quote from: atma at Jul 15, 2009, 01:02 PM

I think the top priority is API documentation. Make it more accessible, readable. One of the good solution for example is CakePHP

http://api.modxcms.com/ - Like such? This is a bit out of date, but we’ll have it updated for the beta-2 release.

Security, Security, Security

User Groups access to Resource Groups

--
Regards
MM

xPDO please. I’d like to see something similar to the documentation for Doctrine with some practical examples. Eg many to many relationships, setting up transactions.

Following on from this, how to integrate a custom resource type (with it’s own db tables) with the document tree.

Quote from: therebechips at Jul 15, 2009, 03:00 PM

xPDO please. I’d like to see something similar to the documentation for Doctrine with some practical examples. Eg many to many relationships, setting up transactions.

Me too! Would someone please read my mind and produce that?

Quote from: therebechips at Jul 15, 2009, 03:00 PM

xPDO please...

8)

Quote from: therebechips at Jul 15, 2009, 03:00 PM

xPDO please. I’d like to see something similar to the documentation for Doctrine with some practical examples. Eg many to many relationships, setting up transactions.

Following on from this, how to integrate a custom resource type (with it’s own db tables) with the document tree.

I’ll be working on this for the next week. You can see the progress here:

http://svn.modxcms.com/docs/display/XPDO10

GetResources could use some examples.

Quote from: BobRay at Jul 15, 2009, 05:28 PM

GetResources could use some examples.

Wanted to suggest the same but then thought Shaun was referring to Revo per se and not 3rd party elements/components? (ye, I know, opengeek’s the author of getResources, but it’s still 3rd party - not part of Revo, right?).

cheers/k