Sure, but it's very limited - it's just a simple readme.  I'm taking about
a full and complete tutorials on the observer pattern, then practical uses
of the EventDispatcher, as a standalone component - something that could be
rendered automatically by Sphinx too.  In order for these technologies to
gain wide acceptance and use it's necessary not only to document the
components well, but to explain the patterns and give a lot of practice
uses.  I've had some amazing responses on my Youtube channel for things I
wrote for our own community (DI, GIT and so on).  Documentation, tutorials
and videos are some of the best ways to evangelise.

What I was thinking was that we could actually introduce a docs/ folder
somewhere in the component's folder.  This is distributed with the
components and also can be rendered to something by version at
symfony.com- would be awesome imo :-D

Drak

On 28 November 2011 20:49, Luis Cordova <cordo...@gmail.com> wrote:

> Drak
>
> lsmith PR'ed sometime ago an initial docu on each component, have you
> checked that?
>
> On Mon, Nov 28, 2011 at 10:02 AM, Drak <d...@zikula.org> wrote:
> > Hi,
> > I wonder if we can start a separate section in the documentation at
> Symfony2
> > for documenting the individual Symfony2 components?  I would like to
> start
> > by writing documentation on the EventDispatcher not only to explain how
> it
> > works, but to also talk about the whole concept of event notification and
> > the observer pattern.  Also, is it okay if I make some videos too?
> > Also, looking at the documentation for individual components, maybe it
> would
> > be much better to keep the documentation in the component repositories,
> that
> > way, each branch/version would have exactly the most op to date
> > documentation for that version of the component...
> > Regards,
> > Drak
> >
> > --
> > If you want to report a vulnerability issue on symfony, please send it to
> > security at symfony-project.com
> >
> > You received this message because you are subscribed to the Google
> > Groups "symfony developers" group.
> > To post to this group, send email to symfony-devs@googlegroups.com
> > To unsubscribe from this group, send email to
> > symfony-devs+unsubscr...@googlegroups.com
> > For more options, visit this group at
> > http://groups.google.com/group/symfony-devs?hl=en
> >
>
> --
> If you want to report a vulnerability issue on symfony, please send it to
> security at symfony-project.com
>
> You received this message because you are subscribed to the Google
> Groups "symfony developers" group.
> To post to this group, send email to symfony-devs@googlegroups.com
> To unsubscribe from this group, send email to
> symfony-devs+unsubscr...@googlegroups.com
> For more options, visit this group at
> http://groups.google.com/group/symfony-devs?hl=en
>

-- 
If you want to report a vulnerability issue on symfony, please send it to 
security at symfony-project.com

You received this message because you are subscribed to the Google
Groups "symfony developers" group.
To post to this group, send email to symfony-devs@googlegroups.com
To unsubscribe from this group, send email to
symfony-devs+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/symfony-devs?hl=en

Reply via email to