Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Move to docs.fsharp.org?

Offen
#76 4 Kommentare 9 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

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

Rechercherichtung

Beginne mit der Prüfung des aktuellen Standorts https://fsharp.github.io/fsharp-core-docs/ und der vorgeschlagenen URL https://docs.fsharp.org/reference sowie der Diskussion im Issue über Microsoft, die .NET Foundation und die FSSF. Kläre, ob sich die Community vor der Definition der Migration auf das Hosting und die kanonische URL einigen kann; abgeschlossen bedeutet ein vereinbartes Ziel und ein umsetzbarer Plan.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

I'd like us to consider working with the FSSF to move https://fsharp.github.io/fsharp-core-docs/ to

https://docs.fsharp.org/reference

As you know, Microsoft and the .NET Foundation host the F# language docs. However the FSharp.Core docs are generated and hosted by the community . This means we have:

https://docs.microsoft.com/dotnet/fsharp/ -- primary F# docs landing page, e.g. Google search for "F# docs"
https://fsharp.github.io/fsharp-core-docs/ -- FSharp.Core docs

There are links across from one to the other. This split structure is not ideal but we have to live with it for now.

I would like us to make the second URL shorter and more canonical, in particular should we utilise docs.fsharp.org to start to host community generated portions of documentation. This would initially mean having this:

https://docs.microsoft.com/dotnet/fsharp/ -- primary F# docs landing page, e.g. Google search for "F# docs"
https://docs.fsharp.org/reference -- FSharp.Core docs

One advantage here is that the canonicals at least for an eventual unified set of docs pages at https://docs.fsharp.org. (We can't have this immediately as it would mean moving the language docs from Microsoft and the .NET Foundation, which would be expensive and cause a maintenance problem). Another advantage is that the FSSF now has the option host whatever additional documentation it likes at https://docs.fsharp.org, though I'm not aware of anything it wants to host. The disadvantage is that people might expect https://docs.fsharp.org to contain all docs for F#.

Best
Don

Vorherrschende Sprache
Keine Sprachdaten
Sterne
37
Forks
20
Ø Merge
5 Min.
Gemergte PRs (30 T.)
2

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus fsharp/fsharp-core-docs

Alle Issues in fsharp/fsharp-core-docs

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

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