Documentation (desperately?) needing improvement, examples etc.

This topic is a public reminder of documentation that I and others came across that is way below standards and should be improved.. feel free to link to specifics here, and please make sure it’s clear what is wrong, unclear or missing.

Hopefully, there are people (including myself) that can make time to increase the quality of the documentation when we know what to change, as the people who know what to do, rarely look into certain documentation...

Please post back when certain documentation mentioned here has been improved.


Evolution
- eForm @ http://rtfm.modx.com/display/ADDON/eForm : quite detailed regarding validation, but there is no guidance on what to do with the codes on there (-> put in a chunk named this or that)


Random links / notes from my docAdditions.txt on my desktop:

Beginner docs
- Building a dynamic menu
- Using a different (background) image per page
- User registration and login
- Step-to-step setting up a dynamic website from a static site.
- Making a real basic contact form http://rtfm.modx.com/display/ADDON/FormIt.Examples.Simple+Contact+Page

- List of as much add-ons as possible with their general purpose, revolution/evolution, on the addon space.


Demo packages
- Static site turned dynamic
-- Including Wayfinder menu, getResources document listing, (Quip commenting)

Tips & Tricks:
- Save with ctrl+alt+s http://modxcms.com/forums/index.php/topic,51160.0.html
http://modxcms.com/forums/index.php/topic,58001.msg339666.html#msg339666
- Faster ExtJS loading in manager (for in CMPs): http://modxcms.com/forums/index.php/topic,59793.msg340121.html#msg340121

Thanks Mark. Please everyone post away here. We really want to assemble a documentation team and a methodology to make it easy to integrate a larger group into the effort while maintaining quality (and NOT making for yet another venue for spammers to invade).

Thanks Ryan.

A documentation team sounds very nice. I know there are people making an effort, but some structure in that could really benefit the whole community. Until that gets sorted, I guess this topic can prove worthy for people who want to help but don’t know where to start.

Started a new category for getResources examples and added a tutorial on making RSS feeds: http://rtfm.modx.com/display/ADDON/getResources.Examples

http://rtfm.modx.com/display/ADDON/getResources.Building+a+RSS+feed


More example uses would be nice!

Great work Mark.

FYI to anyone reading; the documentation is not accessible for editing without credentials to do so. If you’d like to help with contributing to documentation, please let me know in a PM and we’ll get you started.

Yikes! http://rtfm.modx.com/display/ADDON/Ditto+Parameters

Hm. Tried to fix it a little, and it just didn’t like the table at all.

Template Variable input types page is quite empty.. http://rtfm.modx.com/display/revolution20/Template+Variable+Input+Types

Been improved! Thanks Everett! Could still be expended here and there, but seems to be sufficient to start with.

I’m just going to keep going reporting stuff here and when there’s free time just start from the top. I wonder what’s keeping others from doing the same (or maybe they’re just not reporting it?)


Gallery info could be expanded: http://rtfm.modx.com/display/ADDON/Gallery

Is there a plan to internationalize the docs?

@Mark: Can you please update your first post? (formIt is done, TV-Inputs too, etc.)