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

Document potential UX improvements for documentation #48

Closed
4 tasks done
LukSteib opened this issue Apr 14, 2023 · 1 comment · Fixed by #50
Closed
4 tasks done

Document potential UX improvements for documentation #48

LukSteib opened this issue Apr 14, 2023 · 1 comment · Fixed by #50
Assignees

Comments

@LukSteib
Copy link

LukSteib commented Apr 14, 2023

Goal

Improve UX of documentation page

Context

With #42 documentation was introduced.
With this issue we want to collect and tackle potential improvements

Assets

List of things noticed

  • viewport once sidepanel navigation changes so that user first has to horizontally scroll in order to see side panel again (see r1)
  • would be nice to have a visual indication (e.g. color highlighting) on current position in side panel navigation
  • the title element of the whole application is now called Readme (see s1)

r1
https://www.loom.com/share/7100205cdcda4b3a9a063f77b26083ba

s1
image

Tasks

  • Tackle points outlined above
@valiafetisov
Copy link
Contributor

  • It would be nice to show version of the package (but this can only be added once it's integrated via npm)

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

Successfully merging a pull request may close this issue.

2 participants