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

Research: Refactor sidebar in documentation? #264

Open

3 tasks

Syndesi opened this issue Mar 3, 2024 · 0 comments

Labels

Documentation Enhancement

Milestone

Member

Syndesi commented Mar 3, 2024

As the endpoint titles grew longer and longer, maybe the elements within the sidebar should be displayed over two lines? E.g.:

- GET /<uuid>
  Get Element Endpoint
- GET /<uuid>/parents
  Get Parents Endpoint
- GET /<uuid>/children
  Get Children Endpoint

Open questions:

Does such a layout improve readability?
Is such a layout intuitive? Or does it open more questions, especially for new people?
The sidebar is very likely to get longer. Does this affect usability and readability in a negative way?

Syndesi added this to the 0.4.0 milestone

Syndesi added Documentation Enhancement labels

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