File tree Expand file tree Collapse file tree 1 file changed +6
-4
lines changed Expand file tree Collapse file tree 1 file changed +6
-4
lines changed Original file line number Diff line number Diff line change @@ -184,10 +184,12 @@ Documentation
184
184
185
185
All classes and functions must come with full PHPDoc.
186
186
187
- Extensive documentation should also be provided in the
188
- :doc: `reStructuredText </contributing/documentation/format >` format, under
189
- the ``Resources/doc/ `` directory. The ``Resources/doc/index.rst `` file is
190
- the only mandatory file and must be the entry point for the documentation.
187
+ Extensive documentation should also be provided in the ``Resources/doc/ ``
188
+ directory. The index file (for example ``Resources/doc/index.rst `` or
189
+ ``Resources/doc/index.md ``) is the only mandatory file and must be the entry
190
+ point for the documentation. The
191
+ :doc: `reStructuredText (rST) </contributing/documentation/format >` is the most
192
+ common format as it's what's used to render the documentation on symfony.com
191
193
192
194
Installation Instructions
193
195
~~~~~~~~~~~~~~~~~~~~~~~~~
You can’t perform that action at this time.
0 commit comments