Skip to content

[DOC] Add sidebar on homepage of API docs #487

Description

@raybellwaves

Report needed documentation

Describe the documentation you'd like

The home page of the API libraries e.g https://docs.rapids.ai/api/cudf/stable/ and https://docs.rapids.ai/api/cuml/stable/ are mostly landing pages with a summary and a list of the contents of the page. It would be nice is there was a way to configure the landing page to also have the sidebar that is present in the main documentation (see images below). I'm mostly interested a fast way to land on the installation page (https://docs.rapids.ai/install). My user journey (albeit may be unique) was https://github.com/rapidsai/cudf -> https://docs.rapids.ai/api/cudf/stable/ -> https://docs.rapids.ai/api/cudf/stable/user_guide/ then https://docs.rapids.ai/api (once I thought the installation guide would be there) -> https://docs.rapids.ai/install

Nice work on the standardized docs.

Screenshot 2024-03-02 at 6 17 51 PM
Screenshot 2024-03-02 at 6 21 30 PM

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions