Move official docs page to this repo and update accordingly
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Feature
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- fsharp
- Bereich
- build-system, documentation
Rechercherichtung
Beginne damit, die aktuelle fsdocs-Einrichtung in diesem Repository mit den offiziellen Inhalten und der offiziellen Pipeline in plotly.net-docs zu vergleichen, und prüfe documentation/issues/1696 sowie die Issues #353 und #356 auf Einschränkungen. Die Aufgabe ist erledigt, wenn die offizielle Pipeline Tutorial-Inhalte aus diesem Repository verwendet, von fsdocs generierte API-Dokumentation veröffentlicht und nicht mehr auf ein separates Tutorials-Repository oder den fsdocs-Tutorial-Build angewiesen ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Currently, there are 2 sets of docs for this library:
-
docs hosted on https://plotly.net, which i will call internal in this issue:
- built in this repo using
fsdocs - contains tutorials rendered from
.fsxfiles and api docs created by fsdocs via assembly inspection - are up-to-date with the currently version of the library
- almost exclusively F# content (meaning C# users need to put in a little effort translating the code samples)
- built in this repo using
-
docs hosted on https://plotly.com/fsharp and https://plotly.com/csharp , which i will call official in this issue
- built with the behemoth docs build pipeline of plotly, which i currently have absolutely no idea how it works, other than that they most likely use the content of https://github.com/plotly/plotly.net-docs. https://github.com/plotly/documentation/issues/1696 might help here eventually
- contains (incomplete) translations of the python tutorials hosted on https://plotly.com/python
- are severely out-of-date (using a preview version of 2.0.0)
- can host both F# and C# content
There is understandably quite some confusion about this (see #353 and #356), with users coming from the official docs reporting issues that are long fixed in recent versions. In addition to that, providing high-quality C# docs is hard with fsdocs, which mainly focuses on creating F# content with F# tooling.
Since official docs most likely have way better SEO than the internal one, this problem will only increase with time, meaning we should move to only hosting the official docs.
So the following should be done imo:
- change the doc build pipeline to use content in this repo instead of https://github.com/plotly/plotly.net-docs, since i do not want to maintain two separate repos for this. Python , JS, and R versions of plotly do it that way as well.
- use the api docs output from fsdocs, similarily to what the python lib is doing
- ditch fsdocs for the tutorials in favor of the official docs build pipeline.
- Vorherrschende Sprache
- F#
- Sterne
- 860
- Forks
- 99
- Ø Merge
- 22 Min.
- Gemergte PRs (30 T.)
- 1
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus plotly/Plotly.NET
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 78/100
plotly/Plotly.NET#498 ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 42/100
plotly/Plotly.NET#495 · 3 Kommentare ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 45/100
plotly/Plotly.NET#494 · 1 Kommentar ·
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 25/100
plotly/Plotly.NET#492 ·
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 38/100
plotly/Plotly.NET#485 · 1 Kommentar ·
Alle Issues in plotly/Plotly.NET
Ähnliche Issues
-
kind/bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
kubernetes-sigs/prow#953 · 1 Kommentar ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
zephyrproject-rtos/zephyr#119726 ·
-
out-of-date
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 82/100
CachyOS/CachyOS-PKGBUILDS#1894 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
-
comp/dashboard P3 type/bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 86/100
NousResearch/hermes-agent#117722 ·