Symfony has much better documentation than other open source projects! That being said, there is always room for improvement although you should probably post your suggestions on the mailing list dedicated to symfony documentation http://groups.google.com/group/symfony-docs I think you should join the documentation effort and then maybe you suggestions can be implemented one by one. It is always much easier to say what 's wrong than to start doing something about it. I admit, I am guilty too. That 's why I expect to learn how I can be able to contribute on the Symfony BugHuntDay (http://www.symfony-project.org/ blog/2009/10/25/announcing-symfony-bughuntday)
James On 5 nov, 23:07, eMerzh <[email protected]> wrote: > so nobody is interrested helping > or nobody is agree with my feeling? > > Don't be shy :-p > > Brice > > On Mon, Nov 2, 2009 at 21:16, eMerzh <[email protected]> wrote: > > Hi everyone... > > > I'm using symfony for some of my personal and professional development > > > and i think that it's a very nice framework to work with. > > > As a good free software user, i had thought about how to make sf rocks a > > lot more... > > > Some Users (including me sometimes) has expressed here or elsewhere that > > symfony was too hard to learn or not well documented. > > > I just want to point out problems or "not efficient" things that I've > > found. > > > First of all, Official documentation is great, really! but it didn't > > cover everything.. No problems with that, it's not his purpose. > > > The rest of the documentation should be covered by the api.. but > > currently the api doesn't answer the need. > > > Let's take an (bad) example : > > > I'm using a TagHelper and want to add a custom tag. let's see about the > > documentation :http://www.symfony-project.org/api/1_2/TagHelper > > > content_tag ($name, $content = '', $options = array()) > > > $name > > > $content > > > $options > > > ... mmmh i don't know what it mean .... i can easily discover it by > > browsing the code ... but it's quite note efficient. > > > Another problem is that a lot of example (good or bad) are everywhere on > > the web... there is quite no (or not updated at all) un-official > > documentation on the wiki. > > > I can't blame anyone... the wiki is a unnamed mess to me... there is no or > > little structure, no sections, no classification, no verification, no > > distinction between old and new or Propel and doctrine. > > > To solve this i have some propositions: > > > - Make the api more clear and polish the interface ( new search, @see tag > > represented, link between classes, fix entities like $encoding = > > 'base64', ...) > > > - Add content to the api : > > > - let's track what's not/not well documented > > > - add a lot of examples with code colors and comments > > > - add details of all options > > > - add link from and to the official documentation > > > - Reorganize the different categories of the wiki > > > - let's archive the damn oooold and obsoletes articles in the wiki > > > - let's tag which version / flavor is concerned and warn about the (future) > > obsolescence > > > - Invite bloggers and users to copy or allow the copy of there articles on > > the wiki > > > - why not create an Documentation Team / Mailing list > > > Theses are just a start ... please tell me if you found this interesting > > (or not) and if you are eventually interested to contribute. > > > Thanks... > > > Brice Maron > > > --- > > > Brice Maron > > bmaron _.A.T._ gmail.com > >http://bmaron.net --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "symfony users" 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/symfony-users?hl=en -~----------~----~----~----~------~----~------~--~---
