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

Improvement: Increase the width of the main text window in sphinx-needs layout #51

Closed
antonkri opened this issue Dec 9, 2024 · 2 comments · Fixed by useblocks/score#2 or #53
Closed
Assignees

Comments

@antonkri
Copy link
Contributor

antonkri commented Dec 9, 2024

Important

Make sure to link this issue with the PR for your improvement.

Currently the part in the middle of the window with the main text is not sufficient wide and the left part is too large. Please adapt the layout, that the left part gets smaller and the one in the middle larger.

Image

@danwos
Copy link
Contributor

danwos commented Dec 9, 2024

There are pros and cons for a bigger width of the content area.
And there is a huge discussion online and even in academic research, about the ideal width for documentation.
And the main Sphinx themes have chosen the width based on best practices and research results.

One of the main aspects is, that lines containing more than xxx characters are hard to read and follow.
The eyes may jump to the next line.
But every person has their own experience here, so it's really hard to discuss.

Your screenshot shows a really wide screen, I guess something near QHD.
Is this even the whole screen? As the middle seems to be more on the right side :)
But may be also a bug in the documentation css.

So for me, the goal of documentation is not to fill all the white space, if it gets shown in fullscreen mode, but to be easily readable. Like in newspapers, which also have their text in multiple, even less wide, columns.

But these are just my 2 cents, and I'm open to increasing the width.

@danwos
Copy link
Contributor

danwos commented Dec 9, 2024

I made some tests with different widths. Here are the results:

1. width=88rem (default)

Image

2. width= 100rem

Image

3. width= 100rem + optimized left sidebar (less width, 20% instead of 25%) + max_width for huge, wide screens

Less sidebar is not possible, as SCORE has some long titles and especially subtitles get intended and take therefore even more space.
Image

4. fullscreen: width=100% + optimized left sidebar

Image

I like option 3. most. The fullscreen (option 4) looks good, but the text is really hard to read/follow on my QHD monitor.

I will prepare a PR with option 3.

danwos added a commit to useblocks/score that referenced this issue Dec 9, 2024
The width of the content gets increased.

The left sidebar does not show a scrolbar anymore, if the
documentation tree fits in the avaialble space.

Issue-ref: fix eclipse-score#51
danwos added a commit to useblocks/score that referenced this issue Dec 9, 2024
The width of the content gets increased.

The left sidebar does not show a scrolbar anymore, if the
documentation tree fits in the avaialble space.

Issue-ref: fix eclipse-score#51
danwos added a commit to useblocks/score that referenced this issue Dec 9, 2024
The width of the content gets increased.

The left sidebar does not show a scrolbar anymore, if the
documentation tree fits in the avaialble space.

Issue-ref: fix eclipse-score#51
danwos added a commit to useblocks/score that referenced this issue Dec 9, 2024
The width of the content gets increased.

The left sidebar does not show a scrolbar anymore, if the
documentation tree fits in the avaialble space.

Issue-ref: fix eclipse-score#51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
3 participants