mage-os / devdocs-website

Mage-OS devdocs website
3 stars 12 forks source link

(Sticky) page overview #44

Closed Morgy93 closed 1 year ago

Morgy93 commented 1 year ago

Currently there is no overview about the sections of the page while you're scrolling / reading on a page.

It would be great if there is a sticky overview where you can keep track of the page and where you are at all the time.

Example: https://docusaurus.io/docs/styling-layout

image
DavidLambauer commented 1 year ago

Another example here: https://syntax.tailwindui.com/

DavidLambauer commented 1 year ago

I am unsure about this feature tbh. It adds another column to the visual page layout. I am very biased with this change, as it "destroys" the minimal approach a bit 🙈 . @laurali123, could you maybe create a mockup for us?

laurali123 commented 1 year ago

@DavidLambauer @Morgy93 I took the sticky overview from docusaurus as an example. What about putting the overview at the bottom of the page? That will keep the page "clean" and as the users already have an agenda at the top of the page, we'll offer them additionally at the end of the page (the place where you get to after reading the documentation) the opportunity to check in which part of the agenda you currently are:

image image
DavidLambauer commented 1 year ago

Thank you @laurali123 ! I'm not yet convinced, though 😆. I will leave this issue open for a while and get back to it.

Morgy93 commented 1 year ago

Sadly https://github.com/mage-os/devdocs-website/issues/42 was rejected, otherwise it could be bundled together:

image

Source: https://bun.sh/docs/templates#from-github (Just scroll through the page)

DavidLambauer commented 1 year ago

I appreciate your suggestions and it is nice to see what other systems do. I want to stick with a page that is focused on the content with a minimal design. Additional tables or sticky navigations are nice-to-have features that work against that approach.