How do you document your MODx sites?

That’s exactly the type of thing some SQL queries would do nicely...

Quote from: sottwell at Feb 06, 2010, 07:25 AM

I have some reservations about extensive documentation in snippet, module and plugin code (what goes into the Manager fields). These are inserted into the siteCache.idx.php cache file so that the parser can access them without additional database queries. Then ... it bloats the cache file, not to mention the memory arrays in use during parsing.

I’m working on a first site and decided to document the build/learn process in hidden menu items. I thought this might make a good reference for other site managers too, but does this bloat cache/memory or cause a performance hit when done like this? I attach a screenshot image.

In regard to my prior post I used Firebug to study the styles on this page:

http://www.w3.org/MarkUp/Guide/Style

which are excellent styles for documenting code development efforts. A problem with this approach is every time I change the style sheet or template the code must be updated in the container on each page. It is a bit tedious but will create a record of the efforts for future reference.

I suggest the MODx example site be simplified and include a hidden site development tutorial along these lines. It should help new users like me hit the ground running with much less wasted effort.