Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move official docs page to this repo and update accordingly #376

Open
kMutagene opened this issue Mar 15, 2023 · 0 comments
Open

Move official docs page to this repo and update accordingly #376

kMutagene opened this issue Mar 15, 2023 · 0 comments

Comments

@kMutagene
Copy link
Collaborator

Currently, there are 2 sets of docs for this library:

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant