Derek Lamb <[email protected]> wrote: > > Anyway, I think I can improve the wiki. > > you suggest copying several PDL docs into the wiki. I'm not sure > that's a good idea right now, mostly because those documents are > present in the PDL source code (for example, see Impatient.pod). > This makes it easy for these documents to start diverging, making for > a maintenance nightmare. Linking to the relevant online docs is a > good idea, however--those are updated pretty regularly.
Linking is fine. Finding the right docs is more important than making them consistent. > In fact, I just updated the online docs. Look for PDL::Guide in the > manuals section. This may be what you are looking for . A link to > that from the wiki might be a good place to start. Ok, I found it: http://pdl.sourceforge.net/PDLdocs/Guide.html Hmmm... This document is already *much* better than the proposal I wrote. This is a perfect example of PDL having good documentation but it being difficult to find. I don't know what to suggest. This page is *exactly* where a new user should start. No question about it. So I wouldn't just want to add a link some place where nobody will see it. Indeed, I'd love to just copy this to the wiki front page and make small edits. But earlier you warned against copying because of the maintenance cost. Well, at a *minimum* I would say that the 'Documentation' link on the PDL front page should point directly to PDL::Guide. But what do we do about the wiki? What's the purpose of the wiki if all the documentation is in POD? Unless something changes, the wiki ends up either hiding the excellent PDO documentation, or else, competing with POD and dividing the effort. Not good. I fear that this is already what started happening. The wiki has useful pages that should be part of any PDL guide. So the information is already scattered. I don't know what to suggest. Daniel. _______________________________________________ Perldl mailing list [email protected] http://mailman.jach.hawaii.edu/mailman/listinfo/perldl
