statiqdev / Statiq.Docs

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

API Layout Suggestion: put "Syntax" at the top #5

Open SilentSin opened 5 years ago

SilentSin commented 5 years ago

It seems to me that the syntax is even more important than the summary so it should go right under the member heading.

And the Assembly/Namespace/ContainingType should be moved a bit out of the way such as in the top right or even the top left where it already shows the containing type. That section is obviously pretty important for types because it has the inheritance diagram, but for individual members it's always just those 3 things and you usually already know roughly where you are. They could even be shown on a single line at the top: Assembly.dll -> Namespace.ContainingType.

image

Also, I believe C# actually calls it the "Declaring Type" rather than "Containing Type".