[DOC] Add sidebar on homepage of API docs
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- html
- Domain
- documentation
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.
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.
- Dominant language
- HTML
- Stars
- 52
- Forks
- 73
- Avg merge
- 3d 15h
- Merged PRs (30d)
- 7
Getting set up
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.
More from rapidsai/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
rapidsai/docs#818 · 1 comment ·
Maintainers usually reply within 1 day
-
? - Needs Triage doc
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
rapidsai/docs#673 · 1 comment ·
Maintainers usually reply within 1 day
-
[DOC] Publish named versions to docs.nvidia.com via the deploy workflowMay be free again @josephine-wolf-oberholtzer claimed this 54 days ago, and no pull request is open. Open
rapidsai/docs#819 · 1 assignee ·
Maintainers usually reply within 1 day
-
feature request
Difficulty 4/5 3-5 days Newbie friendliness 45/100
rapidsai/docs#751 · 1 reaction ·
Maintainers usually reply within 1 day
Similar issues
-
docs pydanty:is-working
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
pydantic/pydantic-ai#8863 ·
Maintainers usually reply within 1 day
-
documentation from-review-extraction github-actions priority: low severity:nit
Difficulty 1/5 Under an hour Newbie friendliness 92/100
LearningCircuit/local-deep-research#6946 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 1/5 Under an hour Newbie friendliness 88/100
esphome/device-builder#2856 ·
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 78/100
mantinedev/mantine#9223 ·
Maintainers usually reply within 6 days