rapidsai / rapidsai/docs

[DOC] Clicking on the "RAPIDS" logo within the docs of a lib should link to https://docs.rapids.ai/

Open
#635 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

? - Needs Triage doc
Dominant language
HTML
Stars
52
Forks
73
Avg merge
4d 16m
Merged PRs (30d)
8

Description

Report incorrect documentation

When browsing the docs for a given library (say cuDF) I sometimes need to lookup the docs of a related library (say RMM).

From a page in the cuDF docs (ex https://docs.rapids.ai/api/cudf/stable/user_guide/api_docs/api/cudf.core.column.string.stringmethods.split/)
I should be able to click the RAPIDS logo and go to https://docs.rapids.ai/ but instead it goes to https://docs.rapids.ai/api/cudf/stable/

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start from the example cuDF documentation page linked in the issue and inspect how the RAPIDS logo destination is configured. Verify the current link against https://docs.rapids.ai/ and confirm that clicking the logo from a library documentation page reaches the RAPIDS documentation homepage rather than the library path.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.