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.

Sign up for GitHub

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

Jump to bottom

[DOC]: Broken documentation (list of algorithms) #3915

Closed
2 tasks done
tnnandi opened this issue Oct 5, 2023 · 3 comments · Fixed by #3924
Closed
2 tasks done

[DOC]: Broken documentation (list of algorithms) #3915

tnnandi opened this issue Oct 5, 2023 · 3 comments · Fixed by #3924
Assignees
@nv-rliu
Labels
doc Documentation improvement Improvement / enhancement to an existing function non-breaking Non-breaking change

Comments

@tnnandi
Copy link

tnnandi commented Oct 5, 2023

How would you describe the priority of this documentation request

Critical (currently preventing usage)

Please provide a link or source to the relevant docs

https://github.com/rapidsai/cugraph/blob/branch-23.10/readme_pages/algorithms.md

Describe the problems in the documentation

Documentation severely broken, e.g., the page supposed to contain the list of algorithms lead to nowhere: https://github.com/rapidsai/cugraph/blob/branch-23.10/readme_pages/algorithms.md

(Optional) Propose a correction

No response

Code of Conduct

  • I agree to follow cuGraph's Code of Conduct
  • I have searched the open documentation issues and have found no duplicates for this bug report
@tnnandi tnnandi added ? - Needs Triage Need team to review and classify doc Documentation labels Oct 5, 2023
@nv-rliu nv-rliu added improvement Improvement / enhancement to an existing function non-breaking Non-breaking change and removed ? - Needs Triage Need team to review and classify labels Oct 9, 2023
@nv-rliu
Copy link
Contributor

nv-rliu commented Oct 9, 2023

Hi @tnnandi
Thanks for raising this issue. I'll take a look into this. What source directed you to use the link you mentioned above to algorithms.md?

In the meantime, here is a list of supported algorithms in our official docs. Hope this helps

@nv-rliu nv-rliu self-assigned this Oct 9, 2023
@tnnandi
Copy link
Author

tnnandi commented Oct 9, 2023

HI @nv-rliu I was directed to that broken link from the table of content in the readme file.

@nv-rliu nv-rliu mentioned this issue Oct 10, 2023
Merged
@nv-rliu
Copy link
Contributor

nv-rliu commented Oct 10, 2023

Thank you @tnnandi for bringing the broken links to our attention! Those will be fixed shortly.

rapids-bot bot pushed a commit that referenced this issue Oct 11, 2023
@nv-rliu
Update Broken Links in README.md (#3924)
06a840e 
Closes #3915 

This PR fixes two broken links in our README.md file.

Authors:
  - Ralph Liu (https://github.com/nv-rliu)

Approvers:
  - Don Acosta (https://github.com/acostadon)
  - Brad Rees (https://github.com/BradReesWork)

URL: #3924
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nv-rliu nv-rliu

Labels
doc Documentation improvement Improvement / enhancement to an existing function non-breaking Non-breaking change
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update Broken Links in README.md nv-rliu/cugraph
2 participants
@tnnandi @nv-rliu