Hi,
One thing I've seen essentially no discussion of [though maybe
I missed it as usual...] is how and where to write the manual(s)
for an hpkg one has written. The current state actually seems
to be a bit of a mess.
Some apps which have their own folder in system/apps -- like Pe --
put the documentation in that folder. This seems reasonable,
but only applies to those organized like that.
The system/documentation folder doesn't seem to have much
organization at all. There are 'man' and 'info' subfolders, which
again is reasonable for that kind of doc. A couple of packages
('diskusage' and 'pdflib' on my system) have doc folders directly
under system/documentation, but they're the only ones.
The 'packages' subfolder holds the most, but this seems redundant,
as by definition anything in system/documentation must have come
from a package!
A couple of other installed packages (ImageMagick and libxslt)
have put their docs in system/data/docs.
Was there any particular design behind all this, or has it "just growed"?
My personal preference would be to have everything in appropriately
named folders directly under system/documentation, so the user would
know where to look. Any objection to this?
My immediate interest is that I have a command-line app that will
obviously go in .../bin. It has a README and an example that need
to be stashed somewhere, so I'm intending to do as i suggest above.
Thanks,
-- Pete --
