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]: Flatten CUB API documentation section #2896

Open
gonidelis opened this issue Nov 20, 2024 · 0 comments
Open

[DOC]: Flatten CUB API documentation section #2896

gonidelis opened this issue Nov 20, 2024 · 0 comments
Assignees
Labels
2.8.0 target for 2.8.0 release doc Documentation-related items.

Comments

@gonidelis
Copy link
Member

gonidelis commented Nov 20, 2024

Describe the incorrect/future/missing documentation

Our primitives are listed both under

CUB Docs Root
| -- CUB API 
      | -- Namespaces
            | -- cub
cub API

and under

CUB Docs Root
| -- CUB Modules 
      | -- Warp Primitives
      | -- Block Primitives
      | -- Device Primitives
cub Modules

... which is correct. Given that CUB Modules gives a hierarchy view of our CUB primitives.

But it's not right when you peek into our CUB API section. This section should be a long flat page with a list of all our public names (defines, primitives, typedefs etc.) where the user can ctrl+F and look up the name that they want to and redirect accordingly.

This is highlighted by the fact that the API hierarchy is convoluted:

CUB Docs Root
| -- CUB API 
      | -- Namespaces      <-- hm... ok namespaces. nice!
            | -- cub
                  | -- Classes
                  | -- Enums
                  | -- Functions
                  | -- Namespaces      <-- wait, what!? namespaces again? I just want to look up cub::DeviceReduce::Reduce :'(
                  | -- Structs

Task

Make the CUB API section a single flat page which includes all our public names in a web searchable way.

@gonidelis gonidelis added 2.8.0 target for 2.8.0 release doc Documentation-related items. labels Nov 20, 2024
@gonidelis gonidelis self-assigned this Nov 20, 2024
@github-project-automation github-project-automation bot moved this to Todo in CCCL Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.8.0 target for 2.8.0 release doc Documentation-related items.
Projects
Status: Todo
Development

No branches or pull requests

1 participant