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.

Sign up for GitHub

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

Jump to bottom

Improve readability of documentation #2940

Open
Blargian opened this issue Dec 20, 2024 · 0 comments · May be fixed by #2944
Open

Improve readability of documentation #2940

Blargian opened this issue Dec 20, 2024 · 0 comments · May be fixed by #2944
Labels
P3

Comments

@Blargian
Copy link
Collaborator

Blargian commented Dec 20, 2024 •
edited
Loading

ClickHouse documentation has a rather large character count per line. With browser zoom set to 100%, taking this page as an example, the character count with spaces is 219. A count somewhere between 50 - 75 is more optimal for readability (source).

Compare for example ClickHouse docs to ReactNative, MongoDB, Jest docs:

image
(character count with spaces: 219)

image
(character count with spaces: 99)

image
(character counts with spaces: 94)

image
(character count: 148)

Pages will be more readable with a narrower content area.
@Blargian Blargian added the P3 label Dec 20, 2024
@Blargian Blargian linked a pull request Dec 22, 2024 that will close this issue
Open
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
P3
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Make content more readable Blargian/clickhouse-docs
1 participant
@Blargian