Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 0ed9c2d

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

File tree

Expand file treeCollapse file tree

1 file changed

+6
-4
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+6
-4
lines changed

‎bundles/best_practices.rst

Copy file name to clipboardExpand all lines: bundles/best_practices.rst
+6-4Lines 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 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.