symfony/symfony-docs

The official Symfony Documentation

Online version | Components | Screencasts

Contributing

We love contributors! For more information on how you can contribute, please read the Symfony Docs Contributing Guide.

[!IMPORTANT] Use 6.4 branch as the base of your pull requests, unless you are documenting a feature that was introduced after Symfony 6.4 (e.g. in Symfony 7.2).

Build Documentation Locally

This is not needed for contributing, but it's useful if you would like to debug some issue in the docs or if you want to read Symfony Documentation offline.

[!NOTE] The application that builds the Symfony Docs does not support Windows. Windows users should build the docs using a Linux distribution via WSL.

$ git clone [email protected]:symfony/symfony-docs.git

$ cd symfony-docs/
$ cd _build/

$ composer install

$ php build.php

After generating docs, serve them with the internal PHP server:

$ php -S localhost:8000 -t output/

Browse http://localhost:8000 to read the docs.