Re: Package Abstracts

On Tue Nov 16, 2004 at 09:2624AM +0100, Aaron Wormus wrote: > After manning the booth at our LinuxWorld stand and spending a good > amount of time hanging around the booth at IPC2k4, I would like to > propose that we create a simple format of the "mini-documentation" of > EACH package. > > This documentation would not be comprehensive, but would be well written > and provide an overview of what each package does. A good example is > Perl's documentation which requires the following 5 sections: > > Name > Abstract > Synopsis > Description > Notes and Bugs > > I would propose that this documentation be maintained along with the > packages, and updated to be included and installed in the docs/ folder > with each release. What do you think of making the mini documentation part of package.xml? Basically <summary /> and <desc /> already do the job of "Abstract" and "Description" these days, and Greg is working on a new XML layout anyway. -- - Martin Martin Jansen http://martinjansen.com/