Skip to content

Commit 3e2d36b

Browse files
committed
minor #20712 Tweak reference documents (javiereguiluz)
This PR was merged into the 6.4 branch. Discussion ---------- Tweak reference documents As reported by `@stof`, there's a problem with some Configuration Reference documents. **Problem** `h4` and `h5` headings are styled the same on symfony.com This makes hard to understand options like this: https://symfony.com/doc/current/reference/configuration/framework.html#not-compromised-password `enabled` and `endpoint` are sub-keys of `not_compromised_password` while `static_method` is a sibling. Very confusing. **Solution** I don't want to make `h5` even smaller or different in any way. I think that needing to use `h5` reveals a complexity problem in your page. So, let's fix this differently. And I think there could be a very simple solution. Look at the page TOC: ![imagen](https://github.com/user-attachments/assets/350f8567-fd4e-45ef-9f47-10d8fb7002c5) The "useless" `Configuration` title adds a heading level in the entire page, pushing some elements to `h5` level. If we remove it, all the sub-headings go up one level automatically. This will probably be enough. Note that the perfect solution would be to remove `Configuration` heading and update ALL the other headings to use the same heading markers (`---`, `~~~`, etc.) as the rest of Symfony Docs. Doing this would be a merge conflict nightmare. Luckily, reStructuredText format doesn't care about the specific markers used. The first one it finds is h2, the second one is h3 and so on. So, I think it's fine to use different markers just on these reference pages. what do you think? Commits ------- 7ef636c Tweak reference documents
2 parents 01e3f57 + 7ef636c commit 3e2d36b

File tree

5 files changed

+0
-15
lines changed

5 files changed

+0
-15
lines changed

reference/configuration/debug.rst

-3
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,6 @@ key in your application configuration.
2727
namespace and the related XSD schema is available at:
2828
``https://symfony.com/schema/dic/debug/debug-1.0.xsd``
2929

30-
Configuration
31-
-------------
32-
3330
max_items
3431
~~~~~~~~~
3532

reference/configuration/framework.rst

-3
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,6 @@ configured under the ``framework`` key in your application configuration.
1919
namespace and the related XSD schema is available at:
2020
``https://symfony.com/schema/dic/symfony/symfony-1.0.xsd``
2121

22-
Configuration
23-
-------------
24-
2522
.. _configuration-framework-secret:
2623

2724
secret

reference/configuration/security.rst

-3
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,6 @@ key in your application configuration.
1919
namespace and the related XSD schema is available at:
2020
``https://symfony.com/schema/dic/services/services-1.0.xsd``
2121

22-
Configuration
23-
-------------
24-
2522
**Basic Options**:
2623

2724
* `access_denied_url`_

reference/configuration/twig.rst

-3
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,6 @@ under the ``twig`` key in your application configuration.
1919
namespace and the related XSD schema is available at:
2020
``https://symfony.com/schema/dic/twig/twig-1.0.xsd``
2121

22-
Configuration
23-
-------------
24-
2522
auto_reload
2623
~~~~~~~~~~~
2724

reference/configuration/web_profiler.rst

-3
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,6 @@ under the ``web_profiler`` key in your application configuration.
2424

2525
The web debug toolbar is not available for responses of type ``StreamedResponse``.
2626

27-
Configuration
28-
-------------
29-
3027
excluded_ajax_paths
3128
~~~~~~~~~~~~~~~~~~~
3229

0 commit comments

Comments
 (0)