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

No organization and no sectioning issues #4

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

No organization and no sectioning issues #4

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

Comments

@tomaskir
Copy link

tomaskir commented Jan 16, 2020

There is currently 0 organization within the documentation.

This is really bad for multiple issues:

  1. coherence is lost, as everything blends together in the single document
  2. there is no organization, no ToC, no sections
  3. all this causes readers to get easily lost in the documentation
  4. tiny scrollbars due to a single-document design means touching the scrollbar in any way can move you across entire sections of the documentations

The decision to have a single-document NXSL doc is REALLY BAD for UX / usability.

Example:
Let's assume I am a new user that wants to get familiar with available functions in NXSL.
In current wiki, let's look at this page:
image

It gives me a nice overview, I can see available functions, and what their purpose is.
I can then drill-down to each individual function, and get the details I want.

Let's look at the new documentation:
image

When a new user sees this, they will just be completely lost.
There is 0 structuring, no overview, just a lot of data dumped into a single page.

Huge scroll-bars will just scare new users away.

For existing users, it's MUCH easier to find what they need in the old documentation (Wiki), due to easier segmentation and organization of information.

@alkk alkk self-assigned this Jan 20, 2020
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