8000 Question on API docs query service for FSharp.Core things · Issue #7724 · dotnet/dotnet-api-docs · GitHub
[go: up one dir, main page]

Skip to content
Question on API docs query service for FSharp.Core things #7724
Open
@dsyme

Description

@dsyme

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Pri3Indicates issues/PRs that are low priorityarea-MetaConcerns something that extends across runtime area boundaries, for example, IDisposable.doc-enhancementImprove the current contentdoc-ideaIndicates issues that are suggestions for new topicsdotnet-csharp/produntriagedNew issue has not been triaged by the area owner

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0