8000 add mention of symfony.com re folder structure · symfony/symfony-docs@57fcec0 · GitHub
[go: up one dir, main page]

Skip to content

Commit 57fcec0

Browse files
darrylheinxabbuh
authored andcommitted
add mention of symfony.com re folder structure
1 parent 0ed9c2d commit 57fcec0

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

bundles/best_practices.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,8 @@ Documentation
185185
All classes and functions must come with full PHPDoc.
186186

187187
Extensive documentation should also be provided in the ``Resources/doc/``
188-
directory. The index file (for example ``Resources/doc/index.rst`` or
188+
directory (though only required when the documentation is shown on symfony.com).
189+
The index file (for example ``Resources/doc/index.rst`` or
189190
``Resources/doc/index.md``) is the only mandatory file and must be the entry
190191
point for the documentation. The
191192
:doc:`reStructuredText (rST) </contributing/documentation/format>` is the most

0 commit comments

Comments
 (0)
0