plotly / plotly/Plotly.NET

Rework docs to use polyglot notebooks

Ouverte
#442 5 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Area: Documentation
Langage dominant
F#
Étoiles
860
Forks
99
Merge moyen
22 min
PR mergées (30 j)
1

Description

Since fsdocs now supports generation of documentation with notebooks as input, a rework of the docs that also offers side-by-side examples for F# and C# is overdue.

I think this should be done gradually with a mechanism that allows publishing the new and old docs together as long as not all pages are ported.

This also would be a huge step forward for #376 , at least in a way that we could provide the docs in a format that is needed for the official pipeline.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

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.

Piste de recherche

Commencez par examiner la prise en charge par fsdocs de la documentation basée sur des notebooks et les exigences de l’issue #376. Déterminez comment la nouvelle et l’ancienne documentation peuvent être publiées ensemble pendant une migration progressive, puis définissez la portée des exemples F# et C# côte à côte ainsi que le format officiel du pipeline.

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

Évaluation

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

Recevez les nouvelles issues par e-mail

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