Skip to content

Link packages readme to their detailed aspire.dev docs #13366

@Meir017

Description

@Meir017

Is there an existing issue for this?

  • I have searched the existing issues

Is your feature request related to a problem? Please describe the problem.

when using the aspire MCP for gettings docs,

var content = $"""
Instructions for the {packageId} integration can be downloaded from:
https://www.nuget.org/packages/{packageId}/{packageVersion}
Review this documentation for instructions on how to use this package within the apphost. Refer to linked documentation for additional information.
""";
it shows details of the nuget library.

for example https://www.nuget.org/packages/Aspire.StackExchange.Redis/13.0.2#readme-body-tab

it has these links at the buttom:

Additional documentation

Feedback & contributing
https://github.com/dotnet/aspire


would be nice to also have a link to https://aspire.dev/integrations/caching/redis/#client-integration to get more details on this library.

right now the docs on aspire.dev are more detailed than the package's readme

Describe the solution you'd like

aspire packages readme files should have a link to their public docs on aspire.dev (hosting / client-integration sections depending on the library)

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions