Description
Is your feature request related to a problem? Please describe.
For those looking to quickly understand the types of API documentation that can be generated, as well as the XML comments supported, a helpful resource is https://dotnet.github.io/docfx/docs/basic-concepts.html. This page includes a useful example AgeAt(this DateOnly dateOfBirth, DateOnly date)
at the top, along with a screenshot of the generated docs and a link to XML comment syntax.
Describe the solution you'd like
I suggest expanding the existing example or adding an additional one that utilizes all possible XML comments. This would allow users to quickly grasp how everything works and how to implement it themselves.
Perhaps a new page titled "Examples" could be created, allowing the "Basic Concepts" page to remain brief. The new page could then include a link to more in-depth examples.
For reference, this https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/examples, contains various comments supported by C#. If DocFX supports all of these, they would be good candidates for inclusion in the new "Examples" page.
Describe alternatives you've considered
We do have numerous examples in the https://dotnet.github.io/docfx/api/Docfx.html, but one would need to click through multiple pages and then navigate to the GitHub repository to check the XML comments.
Additional context
While some users may be familiar with XML comment syntax, others are not. Enhancing the existing example or adding new ones could further illuminate the functionality provided by additional XML comment types, thereby accelerating improvements to the documentation.