Subject: | Suggested Docs improvement for new-dist.html |
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
10:44:48 < kentnl> rjbs: feedback from <Altreus> on freenode re: http://dzil.org/tutorial/new-dist.html , what the [@Basic] does is unobvious and you don't even realise you need to know what goes on
inside it, and when things go wrong ( Such as a duplicate file with README ) they don't nessecarily get "why"
10:45:09 < rjbs> duplicate files should really be clear.
10:45:20 < rjbs> I will look at that page again, though.
10:45:24 < rjbs> RT tickets == great reminders.
10:45:39 < kentnl> it is written there, but its like in the writing under the code sample under the other code sample
10:46:49 < kentnl> I'd suggest some sort of code-comment such as [@Basic] # Load a list of plugins specified by Dist::Zilla::PluginBundle::Basic
10:47:45 < kentnl> ( like I said, it *is* all there, but it makes sense the way its written only from the perspective of somebody who's been there )
10:47:58 < rjbs> nod
10:48:32 < kentnl> I'd even possibly expand In that page what [@Basic] does, because really, it does *everything*
10:50:46 * kentnl files an rt
10:44:48 < kentnl> rjbs: feedback from <Altreus> on freenode re: http://dzil.org/tutorial/new-dist.html , what the [@Basic] does is unobvious and you don't even realise you need to know what goes on
inside it, and when things go wrong ( Such as a duplicate file with README ) they don't nessecarily get "why"
10:45:09 < rjbs> duplicate files should really be clear.
10:45:20 < rjbs> I will look at that page again, though.
10:45:24 < rjbs> RT tickets == great reminders.
10:45:39 < kentnl> it is written there, but its like in the writing under the code sample under the other code sample
10:46:49 < kentnl> I'd suggest some sort of code-comment such as [@Basic] # Load a list of plugins specified by Dist::Zilla::PluginBundle::Basic
10:47:45 < kentnl> ( like I said, it *is* all there, but it makes sense the way its written only from the perspective of somebody who's been there )
10:47:58 < rjbs> nod
10:48:32 < kentnl> I'd even possibly expand In that page what [@Basic] does, because really, it does *everything*
10:50:46 * kentnl files an rt