Move official docs page to this repo and update accordingly
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- F#
- Estrellas
- 860
- Forks
- 99
- Merge medio
- 22 min
- PR fusionados (30 d)
- 1
Descripción
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.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza comparando la configuración actual de fsdocs en este repositorio con el contenido y la canalización oficiales de plotly.net-docs, y revisa documentation/issues/1696 y los issues #353 y #356 para conocer las restricciones. La tarea estará terminada cuando la canalización oficial consuma el contenido de los tutoriales de este repositorio, publique la documentación de API generada por fsdocs y deje de depender de un repositorio de tutoriales separado o de la compilación de tutoriales de fsdocs.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- fsharp
- Área
- build-system, documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100