forrest-user mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From David Crossley <cross...@apache.org>
Subject Re: Documentation of site.xml and tabs.xml wanted?
Date Fri, 05 Nov 2004 16:17:31 GMT
Clay Leeds wrote:
> David Crossley wrote:
>
> > It might be better to tweak the existing documentation
> > that describes those files. Would you please find where
> > these items are already described and suggest what needs
> > to be enhanced. Perhaps they do need separate description.
> 
> I intend to add a complete *commented-out* (!) example in the actual 
> site.xml & tabs.xml files themselves (for those people A2RTFM--allergic 
> to reading manuals like myself). There is already loads of 
> documentation in those files, however I think a commented out version 
> might help...
> 
> NOTE-TO-SELF:
> - Improve site.xml & tabs.xml files to include commented-out examples.

Yes, we use that approach a lot at Forrest.
Document things inside the actual files. Good.
Probably also need it out in the main documentation.

-- 
David Crossley


Mime
View raw message