-
Notifications
You must be signed in to change notification settings - Fork 915
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
[DOC] README core resource links (docs, examples) should be easier to find #7217
Comments
Hey @bdice, we'd love to have you contribute this! |
This issue has been labeled |
I will work on this soon! 🙂 |
Resolves #7217 by adding a section of commonly needed resource links at the top of the README. In #7217, I also proposed adding relevant badges (e.g. for build status, download links, citation information, etc.). I would be happy to add that to this PR if that is of interest. I'm opening the PR without badges for now, because I think the "Resources" section is valuable by itself, for readers who want quick access to common destinations. Authors: - Bradley Dice (@bdice) Approvers: - Mark Harris (@harrism) URL: #7697
Report needed documentation
Report needed documentation
I was showing cuDF and cuML to a friend and had difficulty finding links to the documentation in the README.
Describe the documentation you'd like
I would like to add a "Resources" section at the top of the README with essential links (docs, examples). I have used this approach with other projects I maintain and have found it is well-liked by users. Examples: freud, HOOMD-blue. These were inspired by other projects from this Awesome READMEs list.
An additional improvement would be to add badges at the top of the README for core services such as docs, containers, citation information, etc. There is currently only one badge, and the rest of the line is empty (could be useful space for additional badges).
I would be happy to contribute this change to the cuDF README and then apply it to other RAPIDS repos once the broad design is solidified. Let me know if you would like to add a Resources section, badges, or both. Other ideas are welcome, of course. 😄
Steps taken to search for needed documentation
The text was updated successfully, but these errors were encountered: