Rework docs to use polyglot notebooks
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- F#
- Sterne
- 860
- Forks
- 99
- Ø Merge
- 22 Min.
- Gemergte PRs (30 T.)
- 1
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die Unterstützung von fsdocs für notebookbasierte Dokumentation und die Anforderungen in Issue #376 zu prüfen. Ermittle, wie neue und alte Dokumentation während einer schrittweisen Migration gemeinsam veröffentlicht werden können, und lege anschließend den Umfang für nebeneinanderstehende F#- und C#-Beispiele sowie das offizielle Pipeline-Format fest.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- csharp, fsharp
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100