Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Move to docs.fsharp.org?

Ouverte
  • Quelque chose ne va pas ?
#76 4 commentaires 9 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
25/100
Type d'issue
Documentation
Clarté
À clarifier
Activité
À l'abandon
Stack technique
fsharp
Domaine
documentation

Piste de recherche

Commencez par examiner l’emplacement actuel https://fsharp.github.io/fsharp-core-docs/ et l’URL proposée https://docs.fsharp.org/reference, ainsi que la discussion de l’issue au sujet de Microsoft, de la .NET Foundation et de la FSSF. Déterminez si la communauté peut parvenir à un accord sur l’hébergement et l’URL canonique avant de définir la migration ; le travail est considéré comme terminé lorsqu’une destination convenue et un plan exploitable existent.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
Aucune donnée de langage
Étoiles
37
Forks
20
Merge moyen
5 min
PR mergées (30 j)
2

Préparer son environnement

Nous n'avons pas encore vérifié les fichiers d'installation de ce projet. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de fsharp/fsharp-core-docs

Toutes les issues de fsharp/fsharp-core-docs

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.