Add links to the docs site in the README #1042
Conversation
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
added
doc
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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 - )
There was a problem hiding this comment.
What do you think about just linking to the markdown files for those two for 22.12?
There was a problem hiding this comment.
I think that sounds good for this release -
|
@gpucibot merge |
README tweaks: