dotnet / dotnet/dotnet-api-docs

Question on API docs query service for FSharp.Core things

Offen
#7,724 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

area-Meta doc-enhancement doc-idea dotnet-csharp/prod Pri3 untriaged
Vorherrschende Sprache
C#
Sterne
950
Forks
1.7k
Ø Merge
2 T. 19 Std.
Gemergte PRs (30 T.)
52

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der VS2022-F1-Abfrage-URL für Microsoft.FSharp.Control.FSharpAsync`1 und vergleiche ihre aktuelle Auflösung mit der Referenzseite von fsharp-core-docs. Untersuche anschließend fsdocs/FSharp.Formatting sowie alle daran beteiligten Query-Services oder die Generierung von Weiterleitungsseiten. Als erledigt gilt die Aufgabe, wenn Symbole der F# Library zur aktuellen Community-Dokumentation oder zu einer geeigneten Weiterleitungsseite aufgelöst werden und nicht zur Dokumentation von Visual Studio 2013.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
fsharp
Bereich
api, documentation
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.