denoland / deno_doc

Documentation generator for Deno
MIT License
253 stars 54 forks source link

[HTML] document navigation should reflect the currently selected overload #592

Closed nberlette closed 2 months ago

nberlette commented 3 months ago

When viewing a symbol that has many overloads, the document navigation gets a bit... cluttered.

Take a look at the attached screenshot, which has several well-documented overloads for a single function named titleCase. All of the overloads are included in the sidebar, but because only the selected one is visible in the DOM, only a few of the links in the sidebar actually work. And there's no indicator which ones they are, since the same names are repeated for each overload.

The navigation should only include links that are to actively navigable content that's currently visible. Currently this is an accessibility nightmare.

Also, I think the example sections should be consolidated into a single Examples link. It's confusing to have five links that each say "Examples", but only link to a single example each. Just my two cents.

Thanks!

image