search

less / less-docs

Documentation for Less.
http://lesscss.org
Other
673 stars 446 forks source link

Docs should begin with TOC #361

Open SetTrend opened 9 years ago

SetTrend commented 9 years ago

It's quite annoying to be required to scroll through the whole document for finding information about a topic.

As a reference document, the LESS documentation (Language Features and Function Reference) should begin with a hyperlinked TOC containing all H1/H2/H3 headers.

seven-phases-max commented 9 years ago

Well, the H1 TOC at the left navbar (also contaning H2 subitems). Technically it's neither a book nor a reference document (but more like a bunch of tutorials + a few distinct reference topics like "Functions"), so a TOC would be too chaotic and sort of useless (about 3-5 screens of pretty random stuff), imho. Maybe an index or sort of would make more sense.

SetTrend commented 9 years ago

That's strange. When I open the doc's I don't see any TOC or index:

toc

TOC or index, it's all the same: Just a nested list of hyperlinks to H1/H2/H3 elements, reflecting their contents. That would help much in using LESS.

lukeapage commented 9 years ago

what browser is that? what happens if the page is wider? looks like something responsive hides it..

seven-phases-max commented 9 years ago

TOC or index, it's all the same

No, by index I mean something like this. And yes, what it's in the screenshot is an issue actually, on narrow width screens the navbar is hidden (probably ideally we should make it accessible there with another dropdown button).

SetTrend commented 9 years ago

Aahhh.... sooo.... OK, now I see... YEEESSS ... That's what I've desperately been looking for.

Excellent!

Thanks for pointing me.

May I suggest to plain put it above content on smaller screens? The TOC is often the first place to look for information.

matthew-dean commented 9 years ago

We should do a mobile-style left-hand menu, where the page slides out of the way revealing the navigation. Stacking it above content will be too heavy.