Want to write some documentation, looking for suggestion on topics

Hi. Sounds weird, but I want to write documentation for MODx. I have started documenting the steps that I followed to convert my site from sNews to MODx. But I’m not sure that the MODx community needs another tutorial. So I’m looking for suggestions on topics that I can bang out quickly and that would benefit the group at large. I poked around the forums a bit but didn’t see anything like a to-do section. If I missed it (and there’s documentation tasks there), please point it out to me.

Man there are so many places to start ... lol

How about a guide on converting a template from a static HTML set of files (including a drop-down menu) into a MODx template including breaking down the logic to make the Wayfinder menu calls and selecting the other resources for the other bits as well?

Yah, it was an open ended question

So another tutorial is good, then? I can do that.

I’m thinking that’d be a good tutorial that lots of folks would find interesting. Though I think I’ve seen one or two similar ones floating about. Maybe the documentation here could use some updating too: http://modxcms.com/documentation.html

What does everyone wish they had more documentation on?

The biggest lack I’ve noticed is an explanation for beginners on how to use the various Tpl chunks to style snippet output (particularly Wayfinder, Ditto, and MaxiGallery). There’s really no place I could find that explains the basics of what things like rowTpl, innerTpl, outerTpl, etc. actually do.

BTW, Here’s my rather feeble attempt at a guide to porting an existing site to MODx:

Bob

I think a good explanation of what a TV is (extra content type). The phrase ’template variable’ was very confusing at first. The docs could be updated for this.

My other ideas:
- very simple Ditto call
- a very simple Wayfinder explanation
- Bindings - these are very powerful but not much documentation on them
- the API pages on the wiki

Is it worth starting on the documentation for 0.9.7?

Quote from: shxen at Feb 01, 2008, 04:04 PM

Is it worth starting on the documentation for 0.9.7?

It might be if you could get the information to write it but I don’t think that’s realistic at this point.

Bob

I would be interested in this as well.

If anyone needs another set of eyes I can help read or write some of the text...

Max

Max, thanks for the offer. I’m pondering a way to proceed.

Based on the suggestions in the responses to my original posting and a quick run through of the questions in this part of the forums, I’ve created the following hit list:

* Convert an existing template to use MODx (from another CMS such as WordPress or one of the freebie sites out there)
* Converting a template from a static HTML set of files (including a drop-down menu) into a MODx template including breaking down the logic to make the Wayfinder menu calls and selecting the other resources for the other bits as well
* A very simple Wayfinder explanation
* Document the API from a user point of view
* The API pages on the wiki
* Explanation for beginners on how to use the various Tpl chunks to style snippet output (particularly Wayfinder, Ditto, and MaxiGallery)
* Explanation of what a TV is (extra content type)
* Very simple Ditto call
* Bindings - these are very powerful but not much documentation on them
* How to create a blog
* How to secure a web site

I think that I’ll start with the first one since I kind of know how to do that already.