Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Move official docs page to this repo and update accordingly

Aberta
#376 0 comentários 3 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
35/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
fsharp
Domínio
build-system, documentation

Direção de pesquisa

Comece comparando a configuração atual do fsdocs neste repositório com o conteúdo e o pipeline oficiais em plotly.net-docs, e revise documentation/issues/1696 e as issues #353 e #356 para verificar as restrições. O trabalho estará concluído quando o pipeline oficial consumir o conteúdo dos tutoriais deste repositório, publicar a documentação da API gerada pelo fsdocs e deixar de depender de um repositório separado de tutoriais ou do build de tutoriais do fsdocs.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

Area: Documentation Area: Meta

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 .fsx files 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)

  • docs hosted on https://plotly.com/fsharp and https://plotly.com/csharp , which i will call official in this issue

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.
Linguagem predominante
F#
Estrelas
860
Forks
99
Merge médio
22min
PRs com merge (30d)
1

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de plotly/Plotly.NET

Todas as issues de plotly/Plotly.NET

Issues semelhantes

Mais issues de Build System

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.