dotnet / dotnet/dotnet-api-docs
Question on API docs query service for FSharp.Core things
- Lingua principale
- C#
- Stelle
- 949
- Fork
- 1.7k
- Merge medio
- 2g 19h
- PR unite (30g)
- 52
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Inizia con l'URL della query F1 di VS2022 per Microsoft.FSharp.Control.FSharpAsync`1 e confronta la sua risoluzione attuale con la pagina di riferimento di fsharp-core-docs. Poi esamina fsdocs/FSharp.Formatting e qualsiasi query service o generazione di pagine di reindirizzamento coinvolti. Il lavoro è completato quando i simboli di F# Library vengono risolti nella documentazione aggiornata della community o in un'apposita pagina di inoltro, invece che nella documentazione di Visual Studio 2013.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- fsharp
- Ambito
- api, documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100