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.

Sign up for GitHub

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

Jump to bottom

fix(docs): Move developer specific docs from README.md to CONTRIBUTING.md #122

Merged
merged 6 commits into from
Jan 23, 2025
Merged

fix(docs): Move developer specific docs from README.md to CONTRIBUTING.md #122

merged 6 commits into from
Jan 23, 2025

Conversation

dagardner-nv
Copy link
Contributor

  • Move the section regarding the test examples to CONTRIBUTING.md, this information is developer specific and resulted in broken links on pypi.org
  • Remove the table of contents, as the anchor tags were similarly broken on pypi.org
  • Misc spelling error fix.

Closes #121

@jameslamb jameslamb self-requested a review January 6, 2025 19:34
@jameslamb jameslamb added doc Improvements or additions to documentation non-breaking Introduces a non-breaking change labels Jan 6, 2025
jameslamb
jameslamb requested changes Jan 6, 2025
View reviewed changes
Copy link
Member

@jameslamb jameslamb 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 this!

I support these changes to make the README a bit better-suited to also being the PyPI.org homepage for the project.

Just one more suggestion... there's one more anchor reference that'll be broken. I think this line can just be removed completely:

dependency-file-generator/README.md

Line 39 in e26f935

> The [Examples](#examples) section below has instructions on where example `dependency.yaml` files and their corresponding output can be viewed.

@dagardner-nv
Copy link
Contributor Author

Thanks for this!

I support these changes to make the README a bit better-suited to also being the PyPI.org homepage for the project.

Just one more suggestion... there's one more anchor reference that'll be broken. I think this line can just be removed completely:

dependency-file-generator/README.md

Line 39 in e26f935

> The [Examples](#examples) section below has instructions on where example `dependency.yaml` files and their corresponding output can be viewed.

Done

jameslamb
jameslamb approved these changes Jan 23, 2025
View reviewed changes
Copy link
Member

@jameslamb jameslamb left a comment

Choose a reason for hiding this comment

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

Thanks @dagardner-nv , and sorry it took so long for me to get back to this!

I just pushed a commit removing one more anchor in the README. I'll merge this once CI passes.

@jameslamb jameslamb merged commit ffd16ec into rapidsai:main Jan 23, 2025
4 checks passed
GPUtester pushed a commit that referenced this pull request Jan 23, 2025
@semantic-release-bot
chore(release): 1.17.1 [skip ci]
be72595 
## [1.17.1](v1.17.0...v1.17.1) (2025-01-23)

### Bug Fixes

* **docs:** Move developer specific docs from `README.md` to `CONTRIBUTING.md` ([#122](#122)) ([ffd16ec](ffd16ec))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jameslamb jameslamb jameslamb approved these changes

Assignees
No one assigned
Labels
doc Improvements or additions to documentation non-breaking Introduces a non-breaking change
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Links on pypi.org are broken
2 participants
@dagardner-nv @jameslamb