plotly / plotly/Plotly.NET

Move official docs page to this repo and update accordingly

未关闭
#376 0 条评论 3 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

Area: Documentation Area: Meta
主要语言
F#
星标
860
派生
99
平均合并
22 分钟
30 天内合并 PR
1

描述

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.

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先,将此仓库中当前的 fsdocs 设置与 plotly.net-docs 中的官方内容和流水线进行比较,并查看 documentation/issues/1696 以及 issues #353 和 #356 以了解约束条件。完成的标准是:官方流水线使用此仓库中的教程内容,发布由 fsdocs 生成的 API 文档,并且不再依赖单独的教程仓库或 fsdocs tutorial build。

由索引模型根据 Issue 内容生成。

评估

技术栈
fsharp
领域
build-system, documentation
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。