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

Link to to documentation on README.md appears broken #67

Closed
henselman-petrusek opened this issue Dec 7, 2022 · 6 comments
Closed

Link to to documentation on README.md appears broken #67

henselman-petrusek opened this issue Dec 7, 2022 · 6 comments

Comments

@henselman-petrusek
Copy link

The link given for documentation is http://spencerlyon.com/PlotlyJS.jl/, but for me this gives a 404 / page not found. Has the documentation moved?

@henselman-petrusek henselman-petrusek changed the title Link to to documentation on Readme.md appears broken Link to to documentation on README.md appears broken Dec 7, 2022
@empet
Copy link

empet commented Dec 7, 2022

The documentation for the last version is here: https://github.com/plotly/plotlyjs.jl-docs/tree/master/julia or here: https://plotly.com/julia/, while PlotlyBase reference, here https://plotly.com/julia/reference/.

Update: github repo for PlotlyJS.jl: https://github.com/JuliaPlots/PlotlyJS.jl

@henselman-petrusek
Copy link
Author

Great, that helps. Should someone open up a pull request to update the readme?

@empet
Copy link

empet commented Dec 8, 2022

No, you shouldn't open up a PR. plotly.jl is used only for uploading a plot to Plotly cloud. You landed in a wrong place, here. As I mentioned above, the github repo for Julia version of plotly.py/plotly.js is PlotlyBase.jl/PlotlyJS.jl. The right README, and link to initial docs are here https://github.com/JuliaPlots/PlotlyJS.jl. Unlike the examples at the links I posted yesterday, for the last version, these docs present the structs involved in the definition of a Plotly figure, and more. Hence, depending on whether an user is a beginer or not, he should start from the initial docs or the docs for the last version.

@henselman-petrusek
Copy link
Author

Thanks, and I promise I'll stop harping on this, but the readme at https://github.com/JuliaPlots/PlotlyJS.jl only has four links:

So even between the two repos, it doesn't seem clear how someone would find directions to get to the right place. Of course, other people may have better googling skills than I do.

@empet
Copy link

empet commented Dec 8, 2022

There is button: docs stable.

@henselman-petrusek
Copy link
Author

Ah! Of course.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants