New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
added basic README files for all components and bridges #2561
Conversation
heavily inspired by http://fabien.potencier.org/article/49/what-is-symfony2 and the official Symfony2 documentation
Great work. For syntax highlighting on the PHP snippets, you could add "php" after the three backticks. |
done |
Nice job, but you also need to add ex : <?php
use Symfony\Component\DomCrawler\Crawler;
$crawler = new Crawler();
$crawler->addContent('<html><body><p>Hello World!</p></body></html>');
print $crawler->filter('body > p')->text(); |
done |
@lsmith77 Well done! This makes consumption of individual components that much easier, especially now that |
flexible as it can look for classes in different directories based on a sub-namespace. | ||
You can even give more than one directory for one namespace: | ||
|
||
``` php |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a non-standard Markdown markup and should be removed. As the code is not indented, any sane Markdown renderer won't output what is expected (try with http://daringfireball.net/projects/markdown/dingus).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok in that case i will just undo the last 2 commits to this branch.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think what fabpot means is that you should also remove ``` and instead use indentation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Basic markdown supports ``` for block indentation; the syntax highlighting is the only thing that's specific to GitHub's renderer.
ok .. fixed the issues you mentioned @fabpot |
@fabpot anything else left? seems like an easy merge .. and imho there is considerable benefit for our efforts to spread the word about the components with this PR merged. |
You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com |
i did that in some. but i might have missed a few places.
|
Pretty excited with this. |
is there anything we can help with to make this ready to be merged? |
@fabpot: seriously .. if you are not going to deliver something "better" and don't provide a reason what is wrong with this .. then its beyond frustrating. i obviously do not claim that these README's are perfect (and certainly still no replacement for proper documentation), but I do claim that in their current form they are a radical step forward to potential users of the Symfony2 components. |
Commits ------- 1e370d7 typo fix 93d8d44 added some more infos about Config 27efd59 added READMEs for the bridges 34fc866 cosmetic tweaks d6af3f1 fixed README for Console 6a72b8c added basic README files for all components Discussion ---------- added basic README files for all components and bridges heavily based on http://fabien.potencier.org/article/49/what-is-symfony2 and the official Symfony2 documentation --------------------------------------------------------------------------- by jmikola at 2011/11/03 13:36:07 -0700 Great work. For syntax highlighting on the PHP snippets, you could add "php" after the three backticks. --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:41:29 -0700 done --------------------------------------------------------------------------- by stealth35 at 2011/11/03 13:49:31 -0700 Nice job, but you also need to add `<?php` ex : ``` php <?php use Symfony\Component\DomCrawler\Crawler; $crawler = new Crawler(); $crawler->addContent('<html><body><p>Hello World!</p></body></html>'); print $crawler->filter('body > p')->text(); ``` --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:56:57 -0700 done --------------------------------------------------------------------------- by ericclemmons at 2011/11/03 19:57:57 -0700 @lsmith77 Well done! This makes consumption of individual components that much easier, *especially* now that `composer.json` files have been added. --------------------------------------------------------------------------- by lsmith77 at 2011/11/04 01:18:23 -0700 ok .. fixed the issues you mentioned @fabpot --------------------------------------------------------------------------- by lsmith77 at 2011/11/11 15:00:27 -0800 @fabpot anything else left? seems like an easy merge .. and imho there is considerable benefit for our efforts to spread the word about the components with this PR merged. --------------------------------------------------------------------------- by drak at 2011/11/11 18:54:13 -0800 You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com --------------------------------------------------------------------------- by lsmith77 at 2011/11/12 00:59:14 -0800 i did that in some. but i might have missed a few places. On 12.11.2011, at 03:54, Drak <reply@reply.github.com> wrote: > You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com > > --- > Reply to this email directly or view it on GitHub: > #2561 (comment) --------------------------------------------------------------------------- by breerly at 2011/11/21 10:28:36 -0800 Pretty excited with this. --------------------------------------------------------------------------- by dbu at 2011/11/24 00:02:50 -0800 is there anything we can help with to make this ready to be merged? --------------------------------------------------------------------------- by lsmith77 at 2011/12/18 02:39:23 -0800 @fabpot: seriously .. if you are not going to deliver something "better" and don't provide a reason what is wrong with this .. then its beyond frustrating. i obviously do not claim that these README's are perfect (and certainly still no replacement for proper documentation), but I do claim that in their current form they are a radical step forward to potential users of the Symfony2 components.
@lsmith77: I've merged this PR and made some quick changes (mostly to add some more examples and references). I don't have time right now to make them better but obviously, there is still a lot of work to be done on them. |
ok thx. i am optimistic that the community will now that there is something concrete as a starting point will begin improving them one at a time. |
Commits ------- 1e370d7 typo fix 93d8d44 added some more infos about Config 27efd59 added READMEs for the bridges 34fc866 cosmetic tweaks d6af3f1 fixed README for Console 6a72b8c added basic README files for all components Discussion ---------- added basic README files for all components and bridges heavily based on http://fabien.potencier.org/article/49/what-is-symfony2 and the official Symfony2 documentation --------------------------------------------------------------------------- by jmikola at 2011/11/03 13:36:07 -0700 Great work. For syntax highlighting on the PHP snippets, you could add "php" after the three backticks. --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:41:29 -0700 done --------------------------------------------------------------------------- by stealth35 at 2011/11/03 13:49:31 -0700 Nice job, but you also need to add `<?php` ex : ``` php <?php use Symfony\Component\DomCrawler\Crawler; $crawler = new Crawler(); $crawler->addContent('<html><body><p>Hello World!</p></body></html>'); print $crawler->filter('body > p')->text(); ``` --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:56:57 -0700 done --------------------------------------------------------------------------- by ericclemmons at 2011/11/03 19:57:57 -0700 @lsmith77 Well done! This makes consumption of individual components that much easier, *especially* now that `composer.json` files have been added. --------------------------------------------------------------------------- by lsmith77 at 2011/11/04 01:18:23 -0700 ok .. fixed the issues you mentioned @fabpot --------------------------------------------------------------------------- by lsmith77 at 2011/11/11 15:00:27 -0800 @fabpot anything else left? seems like an easy merge .. and imho there is considerable benefit for our efforts to spread the word about the components with this PR merged. --------------------------------------------------------------------------- by drak at 2011/11/11 18:54:13 -0800 You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com --------------------------------------------------------------------------- by lsmith77 at 2011/11/12 00:59:14 -0800 i did that in some. but i might have missed a few places. On 12.11.2011, at 03:54, Drak <reply@reply.github.com> wrote: > You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com > > --- > Reply to this email directly or view it on GitHub: > symfony/symfony#2561 (comment) --------------------------------------------------------------------------- by breerly at 2011/11/21 10:28:36 -0800 Pretty excited with this. --------------------------------------------------------------------------- by dbu at 2011/11/24 00:02:50 -0800 is there anything we can help with to make this ready to be merged? --------------------------------------------------------------------------- by lsmith77 at 2011/12/18 02:39:23 -0800 @fabpot: seriously .. if you are not going to deliver something "better" and don't provide a reason what is wrong with this .. then its beyond frustrating. i obviously do not claim that these README's are perfect (and certainly still no replacement for proper documentation), but I do claim that in their current form they are a radical step forward to potential users of the Symfony2 components.
Commits ------- 1e370d7 typo fix 93d8d44 added some more infos about Config 27efd59 added READMEs for the bridges 34fc866 cosmetic tweaks d6af3f1 fixed README for Console 6a72b8c added basic README files for all components Discussion ---------- added basic README files for all components and bridges heavily based on http://fabien.potencier.org/article/49/what-is-symfony2 and the official Symfony2 documentation --------------------------------------------------------------------------- by jmikola at 2011/11/03 13:36:07 -0700 Great work. For syntax highlighting on the PHP snippets, you could add "php" after the three backticks. --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:41:29 -0700 done --------------------------------------------------------------------------- by stealth35 at 2011/11/03 13:49:31 -0700 Nice job, but you also need to add `<?php` ex : ``` php <?php use Symfony\Component\DomCrawler\Crawler; $crawler = new Crawler(); $crawler->addContent('<html><body><p>Hello World!</p></body></html>'); print $crawler->filter('body > p')->text(); ``` --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:56:57 -0700 done --------------------------------------------------------------------------- by ericclemmons at 2011/11/03 19:57:57 -0700 @lsmith77 Well done! This makes consumption of individual components that much easier, *especially* now that `composer.json` files have been added. --------------------------------------------------------------------------- by lsmith77 at 2011/11/04 01:18:23 -0700 ok .. fixed the issues you mentioned @fabpot --------------------------------------------------------------------------- by lsmith77 at 2011/11/11 15:00:27 -0800 @fabpot anything else left? seems like an easy merge .. and imho there is considerable benefit for our efforts to spread the word about the components with this PR merged. --------------------------------------------------------------------------- by drak at 2011/11/11 18:54:13 -0800 You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com --------------------------------------------------------------------------- by lsmith77 at 2011/11/12 00:59:14 -0800 i did that in some. but i might have missed a few places. On 12.11.2011, at 03:54, Drak <reply@reply.github.com> wrote: > You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com > > --- > Reply to this email directly or view it on GitHub: > symfony/symfony#2561 (comment) --------------------------------------------------------------------------- by breerly at 2011/11/21 10:28:36 -0800 Pretty excited with this. --------------------------------------------------------------------------- by dbu at 2011/11/24 00:02:50 -0800 is there anything we can help with to make this ready to be merged? --------------------------------------------------------------------------- by lsmith77 at 2011/12/18 02:39:23 -0800 @fabpot: seriously .. if you are not going to deliver something "better" and don't provide a reason what is wrong with this .. then its beyond frustrating. i obviously do not claim that these README's are perfect (and certainly still no replacement for proper documentation), but I do claim that in their current form they are a radical step forward to potential users of the Symfony2 components.
Commits ------- 1e370d7 typo fix 93d8d44 added some more infos about Config 27efd59 added READMEs for the bridges 34fc866 cosmetic tweaks d6af3f1 fixed README for Console 6a72b8c added basic README files for all components Discussion ---------- added basic README files for all components and bridges heavily based on http://fabien.potencier.org/article/49/what-is-symfony2 and the official Symfony2 documentation --------------------------------------------------------------------------- by jmikola at 2011/11/03 13:36:07 -0700 Great work. For syntax highlighting on the PHP snippets, you could add "php" after the three backticks. --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:41:29 -0700 done --------------------------------------------------------------------------- by stealth35 at 2011/11/03 13:49:31 -0700 Nice job, but you also need to add `<?php` ex : ``` php <?php use Symfony\Component\DomCrawler\Crawler; $crawler = new Crawler(); $crawler->addContent('<html><body><p>Hello World!</p></body></html>'); print $crawler->filter('body > p')->text(); ``` --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:56:57 -0700 done --------------------------------------------------------------------------- by ericclemmons at 2011/11/03 19:57:57 -0700 @lsmith77 Well done! This makes consumption of individual components that much easier, *especially* now that `composer.json` files have been added. --------------------------------------------------------------------------- by lsmith77 at 2011/11/04 01:18:23 -0700 ok .. fixed the issues you mentioned @fabpot --------------------------------------------------------------------------- by lsmith77 at 2011/11/11 15:00:27 -0800 @fabpot anything else left? seems like an easy merge .. and imho there is considerable benefit for our efforts to spread the word about the components with this PR merged. --------------------------------------------------------------------------- by drak at 2011/11/11 18:54:13 -0800 You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com --------------------------------------------------------------------------- by lsmith77 at 2011/11/12 00:59:14 -0800 i did that in some. but i might have missed a few places. On 12.11.2011, at 03:54, Drak <reply@reply.github.com> wrote: > You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com > > --- > Reply to this email directly or view it on GitHub: > symfony/symfony#2561 (comment) --------------------------------------------------------------------------- by breerly at 2011/11/21 10:28:36 -0800 Pretty excited with this. --------------------------------------------------------------------------- by dbu at 2011/11/24 00:02:50 -0800 is there anything we can help with to make this ready to be merged? --------------------------------------------------------------------------- by lsmith77 at 2011/12/18 02:39:23 -0800 @fabpot: seriously .. if you are not going to deliver something "better" and don't provide a reason what is wrong with this .. then its beyond frustrating. i obviously do not claim that these README's are perfect (and certainly still no replacement for proper documentation), but I do claim that in their current form they are a radical step forward to potential users of the Symfony2 components.
Commits ------- 1e370d7 typo fix 93d8d44 added some more infos about Config 27efd59 added READMEs for the bridges 34fc866 cosmetic tweaks d6af3f1 fixed README for Console 6a72b8c added basic README files for all components Discussion ---------- added basic README files for all components and bridges heavily based on http://fabien.potencier.org/article/49/what-is-symfony2 and the official Symfony2 documentation --------------------------------------------------------------------------- by jmikola at 2011/11/03 13:36:07 -0700 Great work. For syntax highlighting on the PHP snippets, you could add "php" after the three backticks. --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:41:29 -0700 done --------------------------------------------------------------------------- by stealth35 at 2011/11/03 13:49:31 -0700 Nice job, but you also need to add `<?php` ex : ``` php <?php use Symfony\Component\DomCrawler\Crawler; $crawler = new Crawler(); $crawler->addContent('<html><body><p>Hello World!</p></body></html>'); print $crawler->filter('body > p')->text(); ``` --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:56:57 -0700 done --------------------------------------------------------------------------- by ericclemmons at 2011/11/03 19:57:57 -0700 @lsmith77 Well done! This makes consumption of individual components that much easier, *especially* now that `composer.json` files have been added. --------------------------------------------------------------------------- by lsmith77 at 2011/11/04 01:18:23 -0700 ok .. fixed the issues you mentioned @fabpot --------------------------------------------------------------------------- by lsmith77 at 2011/11/11 15:00:27 -0800 @fabpot anything else left? seems like an easy merge .. and imho there is considerable benefit for our efforts to spread the word about the components with this PR merged. --------------------------------------------------------------------------- by drak at 2011/11/11 18:54:13 -0800 You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com --------------------------------------------------------------------------- by lsmith77 at 2011/11/12 00:59:14 -0800 i did that in some. but i might have missed a few places. On 12.11.2011, at 03:54, Drak <reply@reply.github.com> wrote: > You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com > > --- > Reply to this email directly or view it on GitHub: > symfony#2561 (comment) --------------------------------------------------------------------------- by breerly at 2011/11/21 10:28:36 -0800 Pretty excited with this. --------------------------------------------------------------------------- by dbu at 2011/11/24 00:02:50 -0800 is there anything we can help with to make this ready to be merged? --------------------------------------------------------------------------- by lsmith77 at 2011/12/18 02:39:23 -0800 @fabpot: seriously .. if you are not going to deliver something "better" and don't provide a reason what is wrong with this .. then its beyond frustrating. i obviously do not claim that these README's are perfect (and certainly still no replacement for proper documentation), but I do claim that in their current form they are a radical step forward to potential users of the Symfony2 components.
Commits ------- 1e370d7 typo fix 93d8d44 added some more infos about Config 27efd59 added READMEs for the bridges 34fc866 cosmetic tweaks d6af3f1 fixed README for Console 6a72b8c added basic README files for all components Discussion ---------- added basic README files for all components and bridges heavily based on http://fabien.potencier.org/article/49/what-is-symfony2 and the official Symfony2 documentation --------------------------------------------------------------------------- by jmikola at 2011/11/03 13:36:07 -0700 Great work. For syntax highlighting on the PHP snippets, you could add "php" after the three backticks. --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:41:29 -0700 done --------------------------------------------------------------------------- by stealth35 at 2011/11/03 13:49:31 -0700 Nice job, but you also need to add `<?php` ex : ``` php <?php use Symfony\Component\DomCrawler\Crawler; $crawler = new Crawler(); $crawler->addContent('<html><body><p>Hello World!</p></body></html>'); print $crawler->filter('body > p')->text(); ``` --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:56:57 -0700 done --------------------------------------------------------------------------- by ericclemmons at 2011/11/03 19:57:57 -0700 @lsmith77 Well done! This makes consumption of individual components that much easier, *especially* now that `composer.json` files have been added. --------------------------------------------------------------------------- by lsmith77 at 2011/11/04 01:18:23 -0700 ok .. fixed the issues you mentioned @fabpot --------------------------------------------------------------------------- by lsmith77 at 2011/11/11 15:00:27 -0800 @fabpot anything else left? seems like an easy merge .. and imho there is considerable benefit for our efforts to spread the word about the components with this PR merged. --------------------------------------------------------------------------- by drak at 2011/11/11 18:54:13 -0800 You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com --------------------------------------------------------------------------- by lsmith77 at 2011/11/12 00:59:14 -0800 i did that in some. but i might have missed a few places. On 12.11.2011, at 03:54, Drak <reply@reply.github.com> wrote: > You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com > > --- > Reply to this email directly or view it on GitHub: > symfony/symfony#2561 (comment) --------------------------------------------------------------------------- by breerly at 2011/11/21 10:28:36 -0800 Pretty excited with this. --------------------------------------------------------------------------- by dbu at 2011/11/24 00:02:50 -0800 is there anything we can help with to make this ready to be merged? --------------------------------------------------------------------------- by lsmith77 at 2011/12/18 02:39:23 -0800 @fabpot: seriously .. if you are not going to deliver something "better" and don't provide a reason what is wrong with this .. then its beyond frustrating. i obviously do not claim that these README's are perfect (and certainly still no replacement for proper documentation), but I do claim that in their current form they are a radical step forward to potential users of the Symfony2 components.
Commits ------- 1e370d7 typo fix 93d8d44 added some more infos about Config 27efd59 added READMEs for the bridges 34fc866 cosmetic tweaks d6af3f1 fixed README for Console 6a72b8c added basic README files for all components Discussion ---------- added basic README files for all components and bridges heavily based on http://fabien.potencier.org/article/49/what-is-symfony2 and the official Symfony2 documentation --------------------------------------------------------------------------- by jmikola at 2011/11/03 13:36:07 -0700 Great work. For syntax highlighting on the PHP snippets, you could add "php" after the three backticks. --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:41:29 -0700 done --------------------------------------------------------------------------- by stealth35 at 2011/11/03 13:49:31 -0700 Nice job, but you also need to add `<?php` ex : ``` php <?php use Symfony\Component\DomCrawler\Crawler; $crawler = new Crawler(); $crawler->addContent('<html><body><p>Hello World!</p></body></html>'); print $crawler->filter('body > p')->text(); ``` --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:56:57 -0700 done --------------------------------------------------------------------------- by ericclemmons at 2011/11/03 19:57:57 -0700 @lsmith77 Well done! This makes consumption of individual components that much easier, *especially* now that `composer.json` files have been added. --------------------------------------------------------------------------- by lsmith77 at 2011/11/04 01:18:23 -0700 ok .. fixed the issues you mentioned @fabpot --------------------------------------------------------------------------- by lsmith77 at 2011/11/11 15:00:27 -0800 @fabpot anything else left? seems like an easy merge .. and imho there is considerable benefit for our efforts to spread the word about the components with this PR merged. --------------------------------------------------------------------------- by drak at 2011/11/11 18:54:13 -0800 You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com --------------------------------------------------------------------------- by lsmith77 at 2011/11/12 00:59:14 -0800 i did that in some. but i might have missed a few places. On 12.11.2011, at 03:54, Drak <reply@reply.github.com> wrote: > You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com > > --- > Reply to this email directly or view it on GitHub: > symfony/symfony#2561 (comment) --------------------------------------------------------------------------- by breerly at 2011/11/21 10:28:36 -0800 Pretty excited with this. --------------------------------------------------------------------------- by dbu at 2011/11/24 00:02:50 -0800 is there anything we can help with to make this ready to be merged? --------------------------------------------------------------------------- by lsmith77 at 2011/12/18 02:39:23 -0800 @fabpot: seriously .. if you are not going to deliver something "better" and don't provide a reason what is wrong with this .. then its beyond frustrating. i obviously do not claim that these README's are perfect (and certainly still no replacement for proper documentation), but I do claim that in their current form they are a radical step forward to potential users of the Symfony2 components.
Commits ------- 1e370d7 typo fix 93d8d44 added some more infos about Config 27efd59 added READMEs for the bridges 34fc866 cosmetic tweaks d6af3f1 fixed README for Console 6a72b8c added basic README files for all components Discussion ---------- added basic README files for all components and bridges heavily based on http://fabien.potencier.org/article/49/what-is-symfony2 and the official Symfony2 documentation --------------------------------------------------------------------------- by jmikola at 2011/11/03 13:36:07 -0700 Great work. For syntax highlighting on the PHP snippets, you could add "php" after the three backticks. --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:41:29 -0700 done --------------------------------------------------------------------------- by stealth35 at 2011/11/03 13:49:31 -0700 Nice job, but you also need to add `<?php` ex : ``` php <?php use Symfony\Component\DomCrawler\Crawler; $crawler = new Crawler(); $crawler->addContent('<html><body><p>Hello World!</p></body></html>'); print $crawler->filter('body > p')->text(); ``` --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:56:57 -0700 done --------------------------------------------------------------------------- by ericclemmons at 2011/11/03 19:57:57 -0700 @lsmith77 Well done! This makes consumption of individual components that much easier, *especially* now that `composer.json` files have been added. --------------------------------------------------------------------------- by lsmith77 at 2011/11/04 01:18:23 -0700 ok .. fixed the issues you mentioned @fabpot --------------------------------------------------------------------------- by lsmith77 at 2011/11/11 15:00:27 -0800 @fabpot anything else left? seems like an easy merge .. and imho there is considerable benefit for our efforts to spread the word about the components with this PR merged. --------------------------------------------------------------------------- by drak at 2011/11/11 18:54:13 -0800 You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com --------------------------------------------------------------------------- by lsmith77 at 2011/11/12 00:59:14 -0800 i did that in some. but i might have missed a few places. On 12.11.2011, at 03:54, Drak <reply@reply.github.com> wrote: > You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com > > --- > Reply to this email directly or view it on GitHub: > symfony/symfony#2561 (comment) --------------------------------------------------------------------------- by breerly at 2011/11/21 10:28:36 -0800 Pretty excited with this. --------------------------------------------------------------------------- by dbu at 2011/11/24 00:02:50 -0800 is there anything we can help with to make this ready to be merged? --------------------------------------------------------------------------- by lsmith77 at 2011/12/18 02:39:23 -0800 @fabpot: seriously .. if you are not going to deliver something "better" and don't provide a reason what is wrong with this .. then its beyond frustrating. i obviously do not claim that these README's are perfect (and certainly still no replacement for proper documentation), but I do claim that in their current form they are a radical step forward to potential users of the Symfony2 components.
Commits ------- 1e370d7 typo fix 93d8d44 added some more infos about Config 27efd59 added READMEs for the bridges cbbe9ae cosmetic tweaks d6af3f1 fixed README for Console b2b2eb2 added basic README files for all components Discussion ---------- added basic README files for all components and bridges heavily based on http://fabien.potencier.org/article/49/what-is-symfony2 and the official Symfony2 documentation --------------------------------------------------------------------------- by jmikola at 2011/11/03 13:36:07 -0700 Great work. For syntax highlighting on the PHP snippets, you could add "php" after the three backticks. --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:41:29 -0700 done --------------------------------------------------------------------------- by stealth35 at 2011/11/03 13:49:31 -0700 Nice job, but you also need to add `<?php` ex : ``` php <?php use Symfony\Component\DomCrawler\Crawler; $crawler = new Crawler(); $crawler->addContent('<html><body><p>Hello World!</p></body></html>'); print $crawler->filter('body > p')->text(); ``` --------------------------------------------------------------------------- by lsmith77 at 2011/11/03 13:56:57 -0700 done --------------------------------------------------------------------------- by ericclemmons at 2011/11/03 19:57:57 -0700 @lsmith77 Well done! This makes consumption of individual components that much easier, *especially* now that `composer.json` files have been added. --------------------------------------------------------------------------- by lsmith77 at 2011/11/04 01:18:23 -0700 ok .. fixed the issues you mentioned @fabpot --------------------------------------------------------------------------- by lsmith77 at 2011/11/11 15:00:27 -0800 @fabpot anything else left? seems like an easy merge .. and imho there is considerable benefit for our efforts to spread the word about the components with this PR merged. --------------------------------------------------------------------------- by drak at 2011/11/11 18:54:13 -0800 You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com --------------------------------------------------------------------------- by lsmith77 at 2011/11/12 00:59:14 -0800 i did that in some. but i might have missed a few places. On 12.11.2011, at 03:54, Drak <reply@reply.github.com> wrote: > You know, it might be a nice idea to put a link to the documentation for each component if there is some at symfony.com > > --- > Reply to this email directly or view it on GitHub: > symfony/symfony#2561 (comment) --------------------------------------------------------------------------- by breerly at 2011/11/21 10:28:36 -0800 Pretty excited with this. --------------------------------------------------------------------------- by dbu at 2011/11/24 00:02:50 -0800 is there anything we can help with to make this ready to be merged? --------------------------------------------------------------------------- by lsmith77 at 2011/12/18 02:39:23 -0800 @fabpot: seriously .. if you are not going to deliver something "better" and don't provide a reason what is wrong with this .. then its beyond frustrating. i obviously do not claim that these README's are perfect (and certainly still no replacement for proper documentation), but I do claim that in their current form they are a radical step forward to potential users of the Symfony2 components.
heavily based on http://fabien.potencier.org/article/49/what-is-symfony2 and the official Symfony2 documentation