statiqdev / Statiq.Docs

A static documentation site generator.
https://statiq.dev/docs
Other
53 stars 8 forks source link

Nested types don't seem to actually be listed anywhere #15

Open SilentSin opened 5 years ago

SilentSin commented 5 years ago

It seems that nested classes don't actually get listed anywhere. Even if they aren't listed in the Class Types list in the sidebar, they should be listed as members of the outer type. The only way I've currently found to get to them is to use the search.

daveaglick commented 5 years ago

Good call - any suggestions where/how they should be listed UI-wise? Alongside outer classes with qualified names maybe? Or only on the page of their containing classes, maybe in a Nested Types section?

SilentSin commented 5 years ago

Definitely in a Nested Types section, possibly before all other members since that's how IL Spy orders things, though I could also see an argument for putting them last. They could even be listed below Derived Types next to the class diagram, though that doesn't have room for their summary so I wouldn't want only that.

I'm not sure how they could fit into the sidebar though since there really isn't much room to work with. Some of my outer classes already take up two lines, so repeating the full name for each nested class would probably be bad. Simply indenting the nested class names under their outer class could work, perhaps even just using a cumulative ... prefix for each nesting level instead of actual indentation. Or a foldout arrow like the docs sidebar uses could work too.

pascalberger commented 1 year ago

With Statiq.Docs nested types no longer seem to be available through search either

daveaglick commented 1 year ago

This seems like a regression, I could swear we had them working. I'll add it to the growing list of stuff 😂.

(On that note, we keep pushing towards a release at work, hence my lack of availability during crunch time. Eventually that'll pass and I'll be able to spend some time here - just don't know when that'll be yet.)

pascalberger commented 1 year ago

Sorry, my mistake. Nested types are still available through search, but only when searching for out class (e.g. when having Foo nested inside Bar, searching for Foo won't find it, but searching for Bar since it is called Bar.Foo)

But having them listed inside the parent class inside a nested types section still would be useful.