plotly / plotly/Plotly.NET

Rework docs to use polyglot notebooks

Aperta
#442 5 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Area: Documentation
Lingua principale
F#
Stelle
860
Fork
99
Merge medio
22m
PR unite (30g)
1

Descrizione

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.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando il supporto di fsdocs per la documentazione basata su notebook e i requisiti dell’issue #376. Determina come pubblicare insieme la documentazione nuova e quella precedente durante una migrazione graduale, quindi definisci l’ambito degli esempi F# e C# affiancati e il formato ufficiale della pipeline.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
csharp, fsharp
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.