You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:

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
0 commit comments