Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature]: Provide an API reference explorer for packages using the generated .xml files inside a package #9776

Open
hach-que opened this issue Jan 12, 2024 · 0 comments
Labels
feature-request Customer feature request

Comments

@hach-que
Copy link

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

@hach-que hach-que added the feature-request Customer feature request label Jan 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request Customer feature request
Projects
None yet
Development

No branches or pull requests

1 participant