[DOC]: Provide more obvious documentation about what Standard Library headers CCCL supports #2108
Open
1 task done
Labels
doc
Documentation-related items.
Is this a duplicate?
Is this for new documentation, or an update to existing docs?
Update
Describe the incorrect/future/missing documentation
As a user of CCCL, I want to be able to quickly and easily reference which Standard Library headers are supported, in addition to any restrictions or extensions to that header. This is likely to be the most common use case for visiting libcu++ docs, so it should be as streamlined and convenient as possible.
If you know where to look, this information is available under the Standard API section, but this isn't as obvious or intuitive as it could be. Typical C++ users are familiar with thinking in terms of individual headers like
<numeric>
and not more abstract groups like "Numerics Library" that contains multiple headers.Desired Solution
To make it easier to find and quickly parse what headers are available, I would like to add a section to the top of the "Standard API" landing page that provides a table of every supported header, what version it was added, and whether there are any restrictions.
Effectively, this should be a concatenation of the tables that already exist in the various "Library" sub-pages, e.g.,
The main libcu++ landing page should also be updated with a very obvious link to this page.
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
The text was updated successfully, but these errors were encountered: