Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
(build) Disable documentation of build script tasks #692
@gep13 I think the question is what's the target audience of this documentation? End-users or developers?
End-users would not be interested in the build scripts available to building the application. Having a "Tasks" menu item that prominent, which also doesn't explain what kind of tasks it documents, is probably quite confusing for them.
For developers having a list of tasks provided by the underlying build script recipe is probably also not that much of an intereset as it doesn't show the actual build process used for this repo (e.g. some tasks are disabled by configuration but still shown here). If we want to have documentation about the build process for developers I would find it much more helpful to have a chapter somewhere mentioning that it uses Cake.Recipe with a link to the Cake.Recipe documentation where the individual tasks already are documented, and additional documentation about repo specific configuration and additional tasks. Or topic specific documentation, like done for the Localization Howto.