For all:
I would high recommend for everyone to take sometime off and think about documentation. First of all, free to comment documentation is win-win for the company behind cakephp/the community, look at Php.net it is the reason it worked, the main site is the documentation, we should also look at django project. http://www.djangobook.com/ 1. PHP.net manual comments are one of the best resource for solutions and answers. 2. Django book project, well i am sure every one will have to agree the inline-comments just worked. it won't distract the main content. cakePHP has been long regard as *late of documentation*, which i don't agree, it is just some really valuable information sitting all over the internet. 2. wiki ending up replaced by bakery for good. 3. official manual is good but still lacking. 4. The Api htmlHelper, formHelper, Model.. etc, they are all pretty sweet, but it happen quite often to me the API only tells us to pass in option array as second parameter without identifying all available options. take a look at mootools project http://docs.mootools.net/, you will expect to find all available options to pass-in to that array. We are lack of good management and organization, User of CakePHP are well disciplined software coders. how hard it is to implement free inline-commenting on official manual. give access to passionate and responsible coders to join the documentation team. someday we can finally *USE* the API as a useful resource with all options identified Sorry for the rant, hope you understand it is for the good. Thanks for reading, until next time On Jun 18, 12:25 am, Dérico Filho <[EMAIL PROTECTED]> wrote: > Hi Jonathan... > > I've made a Linux Shell Script using sed which replaces HTML in the > page's bottom lines to a Javascript which runs the comment system... > > Thus, when a new release of the manual is shipped, I just have to > download it, run the script and upload the new version... > > Now the remarks, I think I will insert a version tag on them... So > when, the Manual version changes, people will know to which version > the remark would refer to. > > Anyway... There will always be a work of cleaning up the flames, the > useless comments or too old to make sense anymore... > > www.cakemanual.org, perhaps? LOL > > Uldérico > > On Jun 16, 11:05 pm, "Jonathan Langevin" <[EMAIL PROTECTED]> wrote: > > > nice addition, just a shame comments aren't available on manual.cakephp.org > > > it seems that your version of the manual deserves it's own domain btw :-) > > > out of curiosity, how will you keep the manual updated properly, and still > > maintain the comments properly? > > > On 6/16/07, Dérico Filho <[EMAIL PROTECTED]> wrote: > > > > Hello Everyone, > > > > I've made available at my site a free-to-comment version of CakePHP > > > Manual... > > > > Please, feel free to access it. > > > >http://www.cirello.org/cakephp-manual/ > > > > Uldérico- Hide quoted text - > > > - Show quoted text - --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Cake PHP" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/cake-php?hl=en -~----------~----~----~----~------~----~------~--~---
