Skip to content

Commit 0ed9c2d

Browse files
darrylheinxabbuh
authored andcommitted
reword the documentation section re Resources/doc
Trying to implement comments made on pull request.
1 parent 4a0632d commit 0ed9c2d

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

bundles/best_practices.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -184,10 +184,12 @@ Documentation
184184

185185
All classes and functions must come with full PHPDoc.
186186

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
191193

192194
Installation Instructions
193195
~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)