Nodejs.dev: Display TOC in a right rail on wide-enough screens

Created on 12 Mar 2019  路  6Comments  路  Source: nodejs/nodejs.dev

Continuing the discussion from https://github.com/nodejs/nodejs.dev/pull/186:

@sagirk in https://github.com/nodejs/nodejs.dev/pull/186#issuecomment-471450486

IMHO adding a huge Table of Contents at the top is generally not a good idea. From the user experience point of view, a user should be able to jump right in and start reading.

+1.

As mentioned I don't think we need that frame and dropdown. When the page is loaded you wanna see the TOC and so you need to make an extra click : ] TOC should be the first thing you see on the page so it outlines shortly what you can read on the page. That's leans on a study method :]

+1 to this too.

@amiller-gh's suggestion was to create a new right rail for the TOC (as a desktop-only feature).

Something like what the VSCode docs do:
image

We could take this on, on a new PR.

@ollelauribostrom in https://github.com/nodejs/nodejs.dev/pull/186#pullrequestreview-212717129

Looks good to me 馃憤 Also like the idea of a right rail for the TOC but that can be addressed later on.

@ahmadawais in https://github.com/nodejs/nodejs.dev/pull/186#issuecomment-471458078

Maybe in a sperate PR we can move towards the always open TOC on the right just as you see in Microsoft docs linked by @sagirk?

discussion enhancement help wanted

Most helpful comment

Taking this up!

All 6 comments

Taking this up!

@imbhargav5 any progress on this one? 馃

Almost done. Will finish it tonight and submit for review 馃槃

馃憢 @imbhargav5 thread bump! 馃榿

馃憢 @imbhargav5 still working on this?

Closing because it references an old design

Was this page helpful?
0 / 5 - 0 ratings

Related issues

benhalverson picture benhalverson  路  3Comments

marcustisater picture marcustisater  路  3Comments

lidoravitan picture lidoravitan  路  4Comments

mhdawson picture mhdawson  路  4Comments

designMoreWeb picture designMoreWeb  路  3Comments