dotnet / dotnet/dotnet-api-docs

Question on API docs query service for FSharp.Core things

Open
#7,724 3 comments 0 reactions 0 assignees View on GitHub
area-Meta doc-enhancement doc-idea dotnet-csharp/prod Pri3 untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

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

* F1 on open in VS2022 goes to https://msdn.microsoft.com/query/dev16.query?appId=Dev16IDEF1&l=EN-US&k=k(Microsoft.FSharp.Control.FSharpAsync`1);k(SolutionItemsProject);k(DevLang-FSharp)&rd=true . This looks ok,

* However the query service then resolves this to [very old documentation for Visual Studio 2013](https://docs.microsoft.com/en-us/previous-versions/visualstudio/visual-studio-2013/ee370518(v=vs.120)?f1url=%3FappId%3DDev16IDEF1%26l%3DEN-US%26k%3Dk(Microsoft.FSharp.Control.FSharpAsync%601);k(SolutionItemsProject);k(DevLang-FSharp)%26rd%3Dtrue).

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.