[DOC] Add sidebar on homepage of API docs
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 52
- Forks
- 73
- Avg merge
- 4d 16m
- Merged PRs (30d)
- 8
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the API documentation home pages for cuDF and cuML with their main documentation pages, using the linked screenshots and URLs as references. Identify how the landing pages and sidebar are configured, then determine whether the sidebar can expose the installation page at docs.rapids.ai/install. Done means the API documentation home page provides the requested sidebar navigation and a clear path to installation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100