You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Having README.md files within packages is great, and helps provide an introduction on how to use a package. But for more complex packages, and packages where they're already extensively documented through the /// <summary> syntax in C#, it'd be great if NuGet could provide an "Explore API" or "API Reference" tab which lists all of the types and methods along with their summaries and parameters, based on all of the .xml files within the package. This would mean that package developers don't have to duplicate reference material into the README.md, when it's already present in the package.
An extra bonus would be some sort of link syntax in the README.md that can link to types and methods in the API Reference tab, like [ISomeInterface](#api-explorer-ISomeInterface).
Additional Context and Details
No response
The text was updated successfully, but these errors were encountered:
Related Problem
No response
The Elevator Pitch
Having README.md files within packages is great, and helps provide an introduction on how to use a package. But for more complex packages, and packages where they're already extensively documented through the
/// <summary>
syntax in C#, it'd be great if NuGet could provide an "Explore API" or "API Reference" tab which lists all of the types and methods along with their summaries and parameters, based on all of the.xml
files within the package. This would mean that package developers don't have to duplicate reference material into the README.md, when it's already present in the package.An extra bonus would be some sort of link syntax in the
README.md
that can link to types and methods in the API Reference tab, like[ISomeInterface](#api-explorer-ISomeInterface)
.Additional Context and Details
No response
The text was updated successfully, but these errors were encountered: