Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Increase landscape width of refguide content for readability #3009

Merged
merged 1 commit into from Apr 11, 2022

Conversation

tmyksj
Copy link
Contributor

@tmyksj tmyksj commented Apr 9, 2022

Refs #2784

I attempted to increase width of refguide content for readability as below. Could you review this, please?

For landscape

At first,
we cannot set max-width to 60% because width may be smaller than 62.5em, e.g., FHD (1920x1080) window's width is (1920px - 20em (padding for header)) * 60% = 60em < 62.5em.

In FHD window, ideally,
1920px * 60% + 8em (div's padding) = 80em is a required width for readability.

For more wide window,
the constant will be smaller than 60% of the window's width.

Thus, max-width is desirable to be maximum of 80em and 60% of a window.

For portrait (phone)

The changes for landscape doesn't affect for portrait because it changes max-width to be increase.

---

So, I set max-width to max(80em, 60%).

Note: max() is supported by most popular browsers exclude Internet Explorer.
https://developer.mozilla.org/en-US/docs/Web/CSS/max


Current: html.tar.gz
Modified: html.tar.gz

@tmyksj tmyksj requested a review from a team as a code owner April 9, 2022 01:41
tmyksj added a commit to tmyksj/reactor-core that referenced this pull request Apr 9, 2022
The reference guide #content div has `max-width: 62.5em`. This is a bit
small for large screens in landscape mode. So, this commit increases the
width.

For landscape, in FHD window, ideally, `1920px` * `60%` +
`8em (div's padding)` = `80em` is a required width for readability. For
more wide window, the constant will be smaller than `60%` of the
window's width. Thus, `max-width` is desirable to be maximum of `80em`
and `60%` of a window.

For portrait (phone), the changes for landscape doesn't affect for
portrait because it changes `max-width` only.

So, this commit set `max-width` to `max(80em, 60%)`.

Fixes reactor#2784.
@tmyksj tmyksj force-pushed the 2784-increaseWidthOfRefguideContent branch from 983e92f to bd0afac Compare April 9, 2022 04:05
tmyksj added a commit to tmyksj/reactor-core that referenced this pull request Apr 9, 2022
The reference guide #content div has `max-width: 62.5em`. This is a bit
small for large screens in landscape mode. So, this commit increases the
width.

For landscape, in FHD window, ideally, `1920px` * `60%` +
`8em (div's padding)` = `80em` is a required width for readability. For
more wide window, the constant will be smaller than `60%` of the
window's width. Thus, `max-width` is desirable to be maximum of `80em`
and `60%` of a window.

For portrait (phone), the changes for landscape doesn't affect for
portrait because it changes `max-width` to be increase.

So, this commit set `max-width` to `max(80em, 60%)`.

Fixes reactor#2784.
@tmyksj tmyksj force-pushed the 2784-increaseWidthOfRefguideContent branch from bd0afac to 4037bad Compare April 9, 2022 23:49
The reference guide #content div has `max-width: 62.5em`. This is a bit
small for large screens in landscape mode. So, this commit increases the
width.

For landscape, in FHD (1920x1080) window, ideally, `1920px` * `60%` +
`8em (div's padding)` = `80em` is a required width for readability. For
more wide window, the constant will be smaller than `60%` of the
window's width. Thus, `max-width` is desirable to be maximum of `80em`
and `60%` of a window.

For portrait (phone), the changes for landscape doesn't affect for
portrait because it changes `max-width` to be increase.

So, this commit set `max-width` to `max(80em, 60%)`.

Fixes reactor#2784.
@tmyksj tmyksj force-pushed the 2784-increaseWidthOfRefguideContent branch from 4037bad to d8bcc28 Compare April 10, 2022 00:02
@simonbasle
Copy link
Member

The mobile / portrait version will probably need a more in-depth investigation and separate issue...
When I zoom out on my mobile phone, paragraphs are visibly smaller than the available space. It seems it has something to do with a couple tables, notably one in the Kotlin section. These tables take the whole width of screen estate while the rest of the content seem stuck with using only a fraction of it 😢

the width change in desktop / landscape mode looks good to me.

if you want to try and investigate the above css issue in a separate PR, that will be greatly appreciated @tmyksj

@simonbasle simonbasle modified the milestones: 3.4.17, 3.5.0-M2 Apr 11, 2022
@simonbasle simonbasle added the type/documentation A documentation update label Apr 11, 2022
@simonbasle simonbasle changed the title Increase width of refguide content for readability Increase landscape width of refguide content for readability Apr 11, 2022
@simonbasle simonbasle merged commit c758a36 into reactor:main Apr 11, 2022
@tmyksj
Copy link
Contributor Author

tmyksj commented Apr 11, 2022

Thank you very much for your review and approval.

if you want to try and investigate the above css issue in a separate PR, that will be greatly appreciated @tmyksj

Yes, I will try it. Could you give me the #issue, please?

@tmyksj tmyksj deleted the 2784-increaseWidthOfRefguideContent branch April 11, 2022 12:41
@simonbasle
Copy link
Member

@tmyksj thanks, here is the follow-up issue: #3011

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants