Closed sypets closed 1 year ago
Yes, I agree, we should reduce visual noise there. Thanks for reporting and compiling the examples. I'll see what I can do in the next versions of the theme. I plan to first show a proposal here.
I have removed the padding, which has the biggest effect. I did not remove the border but set it to white. Looks much butter IMHO.
In normal text:
In a striped table:
In a definition:
To me, some of our pages look "visually cluttered" (not sure what would be a better word). It is distracting, makes it less readable.
The reason, I think, are several, here in this issue I would like to focus on:
The inline code / text roles are often formatted with a darker background and rounded edges. In some cases this may be useful, but we use the inline formatting a lot and often this impedes readability. Personally, it hurts my eyes.
Please compare the 2 screenshots below from Symfony documentation and TYPO3.
Just using backticks, such as is formatted like this:
screenshot
etc.
Also, there is sometimes excessive use of inline code formatting (textroles) and also the excessive use of notes. (I will only focus on the inline code here.) That is a question of how the documentation is written and the conventions, but sometimes other formatting methods might help such as using confval or others.
Examples:
TYPO3
screenshot
screenshot
screenshot
https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ApiOverview/Database/RestrictionBuilder/Index.html
Symfony
They also have less of the formatting, but I think in our case it is combination of both (too much and how it is styled).
Here, not darker background color is used.
screenshot
https://www.doctrine-project.org/projects/doctrine-orm/en/2.13/reference/query-builder.html