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

Docs at readthedocs.io seem broken? #18231

Closed
aggieNick02 opened this issue Jun 2, 2021 · 7 comments · Fixed by #18253
Closed

Docs at readthedocs.io seem broken? #18231

aggieNick02 opened this issue Jun 2, 2021 · 7 comments · Fixed by #18253
Assignees
Labels
category:documentation To resolve the issue, documentation will need to be updated category:question This issue is a question

Comments

@aggieNick02
Copy link
Contributor

Going to the docs at https://vcpkg.readthedocs.io/ linked to from the github page goes to an unformatted table of contents with lots of broken links. I'm guessing this is known but couldn't find an issue for it recently.

Also, it gets a bit confusing when the docs are in two different places - both on github and readthedocs. Which one is authoritative?

@PhoebeHui
Copy link
Contributor

@aggieNick02, we would migrate documentation from readthedocs to vcpkg new website https://vcpkg.io/en/index.html which is available to view as a draft! We really appreciate any and all feedback. You can report new issues in https://github.com/vcpkg/vcpkg.github.io/issues.

@PhoebeHui PhoebeHui added category:documentation To resolve the issue, documentation will need to be updated category:question This issue is a question and removed category:documentation To resolve the issue, documentation will need to be updated labels Jun 2, 2021
@aggieNick02
Copy link
Contributor Author

Thanks for the info. The vcpkg.io page looks really nice!

Should the link from the main github page to https://vcpkg.readthedocs.io/ be removed since the readthedocs page seems broken? Should the readthedocs page be removed?

@PhoebeHui PhoebeHui added the category:documentation To resolve the issue, documentation will need to be updated label Jun 3, 2021
@PhoebeHui
Copy link
Contributor

Thanks for pointing out this! I have submitted a PR to update it.

@dg0yt
Copy link
Contributor

dg0yt commented Jun 3, 2021

But docs at vcpkg.io are outdated as well.

@PhoebeHui
Copy link
Contributor

@dg0yt, we already have issue vcpkg/vcpkg.github.io#48 to track the issue.

@dg0yt
Copy link
Contributor

dg0yt commented Jun 3, 2021

@PhoebeHui Sure. What is missing is some indication when this will be dealt with.

@aggieNick02
Copy link
Contributor Author

Thanks for pointing out this! I have submitted a PR to update it.

Great, thanks so much!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category:documentation To resolve the issue, documentation will need to be updated category:question This issue is a question
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants