Improving the documentation sidebar appearance

TheThingsNetwork / lorawan-stack

The Things Stack, an Open Source LoRaWAN Network Server

https://www.thethingsindustries.com/stack/

Apache License 2.0

975 stars 306 forks source link

Improving the documentation sidebar appearance #3112

Closed nejraselimovic closed 3 years ago

nejraselimovic commented 4 years ago

Summary

While navigating through the documentation site, subsections of the non-selected parent section should be hidden, while the subsections of the selected parent should be visible.

Why do we need this ?

As documentation grows, the sidebar navigation gets messier and this could help improving it.

What is already there? What do you see now?

We have this: sidebar

Can you do this yourself and submit a Pull Request?

@pgalic96 @kschiffer can you help?

pierrephz commented 4 years ago

I think this sidebar is messy also because of the display and we could improve it by doing two things (in addition to Nejra comment above):

Make it as a fixed side div that we can scroll (red notes on the screenshot above) Now, you have to scroll the entire page to scroll le sidebar. This is too much
Create white space between this sidebar and the content (orange notes on the screenshot above) Now we feel oppressed. This is a documentation page, which is kind of heavy content, so user should have some space to breath

johanstokking commented 4 years ago

Is this actionable enough? Who is picking this up?

nejraselimovic commented 4 years ago

Is this actionable enough? Who is picking this up?

Did I assign the right people here?

johanstokking commented 4 years ago

With three people assigned, who's responsible and who does what?

nejraselimovic commented 4 years ago

With three people assigned, who's responsible and who does what?

It's my mistake because I wasn't sure who can actually pull this off and ofc this discussion could be avoided if I asked who can do it before assigning them (will do in the future). I can help, but I don't know how to do this by myself. @kschiffer @pgalic96 can someone pick this one up please?

kschiffer commented 4 years ago

Not your mistake. It's ok to assign more people when in doubt and it's the assignee's responsibility to narrow things down. I would say that @benolayinka is best for implementing this. It should be a relatively simple CSS job.

@benolayinka can you confirm and reassign if necessary then?

benolayinka commented 3 years ago

Moved to https://github.com/TheThingsIndustries/lorawan-stack-docs/issues/97