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] Add sidebar on homepage of API docs #487

Open
raybellwaves opened this issue Mar 2, 2024 · 4 comments
Open

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

raybellwaves opened this issue Mar 2, 2024 · 4 comments
Labels
? - Needs Triage Need team to review and classify doc

Comments

@raybellwaves
Copy link
Contributor

raybellwaves commented Mar 2, 2024

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

@raybellwaves raybellwaves added ? - Needs Triage Need team to review and classify doc labels Mar 2, 2024
@bdice
Copy link
Contributor

bdice commented Mar 7, 2024

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
Copy link
Member

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
Copy link
Contributor

bdice commented Mar 7, 2024

@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
Copy link
Member

ajschmidt8 commented Mar 12, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
? - Needs Triage Need team to review and classify doc
Projects
None yet
Development

No branches or pull requests

3 participants