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

[DOC] README core resource links (docs, examples) should be easier to find #7217

Closed
bdice opened this issue Jan 26, 2021 · 3 comments · Fixed by #7697
Closed

[DOC] README core resource links (docs, examples) should be easier to find #7217

bdice opened this issue Jan 26, 2021 · 3 comments · Fixed by #7697
Labels
doc Documentation

Comments

@bdice
Copy link
Contributor

bdice commented Jan 26, 2021

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

  1. I looked for a "docs" badge (does not exist)
  2. I kept reading for about 1 screen, hoping to find a link in the README with the text "Documentation"
  3. I tried to find a documentation link at the top of the repo page in the "About" section or perhaps the repo's "homepage" link (which points to rapids.ai, which is fine)
  4. I finally found the docs link after a long code block, in the middle of a sentence ("For additional examples, browse our complete API documentation, ...")
@bdice bdice added doc Documentation Needs Triage Need team to review and classify labels Jan 26, 2021
@harrism
Copy link
Member

harrism commented Jan 27, 2021

Hey @bdice, we'd love to have you contribute this!

@harrism harrism removed the Needs Triage Need team to review and classify label Jan 27, 2021
@github-actions
Copy link

This issue has been labeled inactive-30d due to no recent activity in the past 30 days. Please close this issue if no further response or action is needed. Otherwise, please respond with a comment indicating any updates or changes to the original issue and/or confirm this issue still needs to be addressed. This issue will be labeled inactive-90d if there is no activity in the next 60 days.

@bdice
Copy link
Contributor Author

bdice commented Feb 26, 2021

I will work on this soon! 🙂

bdice added a commit to bdice/cudf that referenced this issue Mar 24, 2021
rapids-bot bot pushed a commit that referenced this issue Mar 24, 2021
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants