praeclarum/FuGetGallery

[Feature Request] FuGet as cross-reference service

sakno opened this issue · 5 comments

sakno commented

It would be great to make cross-reference links to API doc generated by FuGet for arbitrary package. Microsoft Docs already provides cross-reference link resolution via https://xref.docs.microsoft.com/query?uid={uid}

praeclarum commented

That is a super cool service but can you tell me what exactly you would like to see in NuGet?

Do you want a query type API that returns JSON as in the MS service, or do you want a UI?

sakno commented

Just JSON. This allows to use FuGet XREF service for generating references to types in documentation built with DocFX. At the moment, I'm using hand-written tool that generates cross-references for DocFX as static resources. It's workaround, but in future documentation build pipeline can be simplified.

sakno commented

Here is real-world example where I'm using cross-references pointing to FuGet Gallery in my project: https://sakno.github.io/dotNext/features/core/index.html

praeclarum commented

Great, got it, thanks. Yes, I think it's very doable. The only trouble is don't index APIs which would be needed to make this work.

The good news I want to start indexing them so can add this feature when that's done.

  • 👍1
sakno commented

One more thing. XRef support will be a killer feature because DocFX generator of API documentation currently doesn't support C# 9 and some other features:

  • No support of API doc for multiple targets (FuGet can do that right now)
  • No multiple versions of the same API (FuGet can do that right now)
  • No function pointers