rapidsai / docs

RAPIDS Documentation Site
https://docs.rapids.ai
37 stars 52 forks source link

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

Open raybellwaves opened 8 months ago

raybellwaves commented 8 months ago

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

bdice commented 8 months ago

Thanks for the request! I believe that there are some ongoing website revisions will improve the overall navigation experience when it's ready.

cc: @exactlyallan @ajschmidt8 for awareness of this request.

ajschmidt8 commented 8 months ago

This particular request will need to be handled in cudf's docs since this page is generated via Sphinx.

@bdice, should we move this issue to the cudf repo?

bdice commented 8 months ago

@ajschmidt8 Yes, we can add the sidebar -- but this was the original goal:

I'm mostly interested a fast way to land on the installation page (https://docs.rapids.ai/install).

I think this would be handled better by the docs/main site integration, right? The sidebar itself isn't the goal.

ajschmidt8 commented 8 months ago

I think this would be handled better by the docs/main site integration, right? The sidebar itself isn't the goal.

Yes, we'll have some navigation improvements then. This will likely be addressed as part of those improvements.