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

Visual coherence issues - styling and formatting problems #2

Open
tomaskir opened this issue Jan 16, 2020 · 2 comments
Open

Visual coherence issues - styling and formatting problems #2

tomaskir opened this issue Jan 16, 2020 · 2 comments
Assignees

Comments

@tomaskir
Copy link

A lot of parts of the documentation blend together into an un-readale mess, since there is no visual consistent signature for segmentation of topics / segments.

For example:
image

Looking at this from a UX / visual perspective, there is almost no segmentation between different sections (which in this case would be NXSL functions), which causes the reader to get lost easily.

As for more examples, where the Function Reference ends and Class Reference starts - there is no visual indication. The reader could scroll by that without even noticing we are in completely different documentation sections now:

image

There is 0 visual indication I have just left a major section of the documentation (Function Reference) and went to a new one (Class Reference).

@alkk alkk self-assigned this Jan 20, 2020
@alkk
Copy link
Member

alkk commented Jan 20, 2020

@tomaskir
Copy link
Author

tomaskir commented Jan 21, 2020

This is better in regards to the other tickets, but to the issues described in this ticket, I personally don't find much improvement.

Scrolling across the function reference, you still have to pay attention really hard to not accidentally scroll into the same part of a different function.

I personally think some "containers" that would wrap a single function and visually separate it from the following one would REALLY help.

Something like this:
Screenshot_2020-01-21_11-22-44
this is a fast mockup - please disregard the colors and the quality ;)

This would achieve 3 things:

  1. clearly highlight the function header (name)
  2. clearly show the "body" of documentation belonging to that function
  3. separate the previous body from the next header, both by a white spacer, and by the next header being the header color

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

No branches or pull requests

2 participants