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

Add nx-cugraph Intro to API Docs Page #538

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

nv-rliu
Copy link
Contributor

@nv-rliu nv-rliu commented Sep 5, 2024

Closes https://github.com/rapidsai/graph_dl/issues/606

Proposed Changes:

  • This PR adds a section to RAPIDS Docs > API Docs for nx-cugraph
  • The nx-cugraph docs will live inside the cugraph docs, but they have their own dedicated landing page and Table of Contents (Add nx-cugraph Docs Pages cugraph#4669)

Proposed change looks like:

image
as of 5458bbd

@nv-rliu nv-rliu requested a review from a team as a code owner September 5, 2024 18:07
Copy link

netlify bot commented Sep 5, 2024

Deploy Preview for docs-rapids-ai ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 21d7b0e
🔍 Latest deploy log https://app.netlify.com/sites/docs-rapids-ai/deploys/6712d3fe1a08b600082e9742
😎 Deploy Preview https://deploy-preview-538--docs-rapids-ai.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

_data/docs.yml Outdated Show resolved Hide resolved
_data/docs.yml Outdated Show resolved Hide resolved
_data/docs.yml Outdated Show resolved Hide resolved
_data/docs.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@bdice bdice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it make sense to merge this before nx-cugraph has its own documentation? Should we just note nx-cugraph under the cuGraph section? All the other entries on this page have a unique path: which corresponds to the docs URL. We don't publish nx-cugraph docs on their own (yet) so I don't see a large benefit to adding this link because it duplicates the link to existing cuGraph content.

I would vote to wait on merging this until we publish nx-cugraph docs at their own page (https://docs.rapids.ai/api/nx-cugraph/stable/, which doesn't exist yet) and then we can update the path: accordingly.

Copy link

vercel bot commented Oct 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview Oct 18, 2024 9:33pm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants