Commit 3e2d36b
committed
minor symfony#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 documentsFile tree
5 files changed
+0
-15
lines changed- reference/configuration
5 files changed
+0
-15
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
30 | | - | |
31 | | - | |
32 | | - | |
33 | 30 | | |
34 | 31 | | |
35 | 32 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | 22 | | |
26 | 23 | | |
27 | 24 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | 22 | | |
26 | 23 | | |
27 | 24 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | 22 | | |
26 | 23 | | |
27 | 24 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
27 | | - | |
28 | | - | |
29 | | - | |
30 | 27 | | |
31 | 28 | | |
32 | 29 | | |
| |||
0 commit comments