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 usability of documentation #492

Open

nimo23 opened this issue Apr 8, 2021 · 0 comments

nimo23 commented Apr 8, 2021 •

edited

Loading

Please provide a fixed left sidebar for TOC (Table of Contents). Currently, the TOC scrolls with the content which is uncomfortable. And please use toggles for the main concepts of the TOC. Currently, the user must scroll a lot up and down. For inspiration, look at

https://lodash.com/docs/4.17.15 (fixed left sidebar with collapsable items for TOC)
https://reactjs.org/docs/getting-started.html (fixed right sidebar with collapsable items for TOC)
https://developer.microsoft.com/en-us/fluentui#/controls/web/button (fixed left sidebar with collapsable items for TOC)
https://flutter.dev/docs (fixed left sidebar with collapsable items for TOC)

And please consider to use another more readable font for better readability. At least, make the font-size and line-height a little smaller. Currently, the font-size (for desktop) is 16 (and line height is 1.6) which is, in my opinion, very uncomfortable to read. Compare the font (size and line-height) with the others example above (which uses, for example, font-size: 14, line-height: 1.3).

nimo23 changed the title ~~Improve usability of TOC~~ Improve usability of documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment