We never put documentation in the main Symfony repo. This should go in symfony-docs

If we don't document this in the bundle's repository, then we won't be able to display it on https://symfony.com/doc/bundles/

Besides, other bundles already have short docs in this repo: https://github.com/symfony/monolog-bundle/blob/master/Resources/doc/index.rst and https://github.com/symfony/swiftmailer-bundle/blob/master/Resources/doc/index.rst

Ah, so the difference between this bundle and those bundles is that they are in separate repositories. But, since we're moving towards not including symfony/symfony, it does indeed make more sense to begin documenting the individual bundles as if they were separated.

So, 👍 in theory, but I kinda doubt that Fabien will want big docs like this living in this repo. Would it be a better idea (for bundles that are actually inside symfony/symfony) to add a bundles/ directory in symfony/symfony-docs and update symfony.com to be able to pull from that?

I like the idea of @weaverryan

I've just pushed an alternative in #22607. I think it's better to not duplicate documentation. Commands should be documented so that help is available on the CLI. I've also reused the description of the component in the README. That should be enough I think.

@fabpot Basic usage and installation should be documented on the Symfony website under the bundles/ path, regardless of the completeness of the CLI documentation, IMHO. Especially as more and more items are split into their own packages (regardless of the fact that they all actually exist in a single root repo). What did you think of creating a bundle documentation root within symfony-docs that symfony.com learns to also pull from?

@robfrawley Installation is a no-brainer with Flex. And there is no documentation except the CLI commands as the bundle is just about that. I don't see the point.