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

[DOC]: Make it more obvious that the public docs at https://nvidia.github.io/libcudacxx/ are out-dated (especially to search engines) #1289

Closed
1 task done
MatthiasKohl opened this issue Jan 17, 2024 · 6 comments
Assignees
Labels
doc Documentation-related items.

Comments

@MatthiasKohl
Copy link

Is this a duplicate?

Is this for new documentation, or an update to existing docs?

Update

Describe the incorrect/future/missing documentation

IMO, there's only a few good options for dealing with the docs at https://nvidia.github.io/libcudacxx/:

  1. re-direct to https://nvidia.github.io/cccl/libcudacxx/ and potentially include the content of the old page somewhere there under "archive".
  2. put a very obvious header on every single html page under https://nvidia.github.io/libcudacxx/ that it is outdated, not a single non-obvious message which only appears on the "Overview" page.

Otherwise, anyone looking for docs on APIs within libcu++ directly will most certainly miss the latest docs.
It's possible that something similar applies to cub and thrust, but I haven't confirmed this.

If this is a correction, please provide a link to the incorrect documentation. If this is a new documentation request, please link to where you have looked.

No response

@MatthiasKohl MatthiasKohl added the doc Documentation-related items. label Jan 17, 2024
@jrhemstad
Copy link
Collaborator

Howdy and thanks for the reminder, there have been a few loose ends we hadn't tied up since our migration to the new repo and this is definitely top of that list.

Setting up the link redirection is tracked here: #642 and @wmaxey will be working on that ASAP.

@ahendriksen
Copy link
Contributor

I get questions about the old docs at least once per week. Would it be possible as a temporary fix to add a large banner on top pointing to the new repo?

@ahendriksen
Copy link
Contributor

I submitted a PR for the old repo to make it more clear that the old docs are deprecated and link to the new docs.

NVIDIA/libcudacxx#509

@jrhemstad
Copy link
Collaborator

Thanks to @wmaxey, any URL that pointed to the old repo will now be automatically redirected to the new docs

Try it out! https://nvidia.github.io/libcudacxx/

@bdice
Copy link
Contributor

bdice commented Mar 14, 2024

@jrhemstad Can this be closed?

@jrhemstad
Copy link
Collaborator

Yes!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation-related items.
Projects
Archived in project
Development

No branches or pull requests

5 participants