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 links to the docs site in the README #1042

Merged
merged 4 commits into from
Nov 23, 2022

Conversation

benfred
Copy link
Member

@benfred benfred commented Nov 22, 2022

README tweaks:

  • Add a resources section with links to the generated HTML documentation
  • Add a build status badge
  • Add a section about installing with the new experimental pip packages

README tweaks:

* Add a resources section with links to the generated HTML documentation
* Add a build status badge
* Add a section about installing with the new experimental pip packages
@benfred benfred added doc Documentation non-breaking Non-breaking change documentation Improvements or additions to documentation and removed doc Documentation documentation Improvements or additions to documentation labels Nov 22, 2022
Copy link
Member

@cjnolet cjnolet left a comment

Choose a reason for hiding this comment

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

Thanks for adding these! I think they look good, but it's also a good opportunity to make links to the RAFT getting started and build instructions front and center.

README.md Outdated
## Resources

- [RAFT Reference Documentation](https://docs.rapids.ai/api/raft/stable/): API Documentation.
- [Getting Started](https://rapids.ai/start.html): Instructions for installing RAFT.
Copy link
Member

Choose a reason for hiding this comment

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

I think maybe we should remove this one or rename it to "RAPIDS Getting Started" here and provide links to the "RAFT getting started" and "Build and Install RAFT" instructions from the RAFT docs above it.

Like RMM, RAFT isn't explicitly listed on the RAPIDS getting started page.

Copy link
Member Author

Choose a reason for hiding this comment

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

I've updated to point to installing and getting-started sections in the README (making this section partially act like a TOC I guess).

I couldn't link to the docs site just yet for the build + getting started though: The stable 'build.html' page doesn't exist here yet https://docs.rapids.ai/api/raft/stable/build.html , though I do see it at on the nightly docs site here https://docs.rapids.ai/api/raft/nightly/build.html

(alternatively, I could link to the https://docs.rapids.ai/api/raft/nightly pages for these two links and update once 22.12 is out the door - )

Copy link
Member

@cjnolet cjnolet Nov 23, 2022

Choose a reason for hiding this comment

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

What do you think about just linking to the markdown files for those two for 22.12?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think that sounds good for this release -

Copy link
Member

@cjnolet cjnolet left a comment

Choose a reason for hiding this comment

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

Looks great!

@cjnolet
Copy link
Member

cjnolet commented Nov 23, 2022

@gpucibot merge

@rapids-bot rapids-bot bot merged commit d244647 into rapidsai:branch-22.12 Nov 23, 2022
@benfred benfred deleted the docs_link_readme branch December 1, 2022 21:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation non-breaking Non-breaking change
Projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants