dotnet / dotnet-api-docs

.NET API reference documentation (.NET 5+, .NET Core, .NET Framework)
https://docs.microsoft.com/dotnet/api/
Other
679 stars 1.52k forks source link

Question on API docs query service for FSharp.Core things #7724

Open dsyme opened 2 years ago

dsyme commented 2 years ago

Visual Studio uses a query service to resolve use of the F1 keyword. When working in the F# tooling, for .NET things like System.String, this resolves correctly. However for F# Library things (e.g. Async) things go wrong

We'd like to adjust the query service to either go to the community-generated docs like this:

  Microsoft.FSharp.Control.FSharpAsync`1   --> https://fsharp.github.io/fsharp-core-docs/reference/fsharp-control-fsharpasync.html

and in general like this (putting aside some issues with the `1 and so on)

 Microsoft.AAA.BBB.CCC   --> https://fsharp.github.io/fsharp-core-docs/reference/aaa-bbb-ccc.html

or to an auto-generated dotnet-api-docs page that auto-forwards to the corresponding F# community docs. If necesary fsdocs/FSharp.Formatting can be modified to generate additional redirecting target pages.

So my question is: what do we need to do to make this happen correctly?

Thanks

dotnet-issue-labeler[bot] commented 2 years ago

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

gewarren commented 2 years ago

Perhaps @kexugit can help here?

dsyme commented 2 years ago

@kexugit Any ideas? Thanks!