Re: [Module::Build] Yet Another Documentation Split
Status: Beta
Brought to you by:
kwilliams
From: Randy W. S. <ml...@th...> - 2006-04-14 10:24:28
|
Ken Williams wrote: > > On Mar 29, 2006, at 7:48 PM, Randy W. Sims wrote: > >> I was looking over the Cookbook to see about clarifying the docs on >> adding new types of build elements, but to me it looks fine for what >> it is: basic quick recipes to accomplish a task. I think the two >> examples there cover the basic ideas. Perhaps we could go into more >> detail, but the Cookbook doesn't seem the place for that. >> >> So I looked at putting a section in Authoring. Authoring is filled >> with pages and pages of reference on methods and constructor args. >> Then way down at the bottom is some background info on creating >> Build.PL scripts. >> >> I was thinking it be nice to just move the reference material to a >> another document, Reference.pod; and allow Authoring to be an >> instructional guide to authoring. >> >> Should I do this? And is it ok to do so now? or wait? > > > How about calling the new document API.pod or something like that? > > I'm not sure whether we should do that now or not - I think it wouldn't > really cause much trouble, but I'd rather focus our efforts more > narrowly just now. I could go either way, though. In the interests of focusing and enhancing the Authoring document (and at the risk of being insubordinate) I've put together a preliminary patch. I'd really like to get more information in there about custom install elements, install paths, custom actions, etc; and I think this will help make the information more accessible. (and it took very little time to do it) Randy. |