dotnet / AspNetCore.Docs

Documentation for ASP.NET Core
https://docs.microsoft.com/aspnet/core
Creative Commons Attribution 4.0 International
12.63k stars 25.29k forks source link

Convert ToC parent nodes to only expand/collapse #8871

Closed tdykstra closed 6 years ago

tdykstra commented 6 years ago

Fixed by #9133

guardrex commented 6 years ago

On several Index pages, I added the topic descriptions to help the reader understand more about what's in each topic.

For example, see:

These examples have a single lead-in line to orient the reader to the node's articles. (I think the single line in these cases can be further improved.)

I like Fundamentals: Hosting because it provides an expanded introduction blurb about what the whole section pertains to (better than a single line), then it has the links+descriptions.

I speculate that eliminating Index pages in most cases forces readers to click on several topics in the node to see what each section of the TOC is about and what each topic covers (if the titles aren't very descriptive), while a well-crafted Index page aids in navigation and understanding.

Therefore, I suggest considering the wise use of Index pages before removing them. If you would like to see a further example of what I propose, allow me to present you with a before and after example using one of the existing link-list-formatted pages. For example, I could take DP implementation Index, do a quick number on it (it would only take a few minutes), and then you could see what I mean.

tdykstra commented 6 years ago
guardrex commented 6 years ago

TL;DR Shortening down to ...

I don't want to draw conclusions without testing.

The Index pages that are link-lists are useless, yes. However, I don't recommend a wholesale deletion of the pages. I think these pages should be assessed on a case-by-case basis to see which ones can be enhanced into something useful. Just a suggestion.

tdykstra commented 6 years ago

We're planning to do some experimentation/user testing with the ToC, so this will be one of the areas we'll look at. But I think all or none should be expand/collapse, so you know what to expect when you click a parent node.

guardrex commented 6 years ago

The silly GooberRex:tm: disagrees :smile:, but thanks for hearing me out.