Skip to content

Consolidate shared info between README.md and DESCRIPTION.rst #590

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
Merged
merged 5 commits into from
Apr 29, 2025
Merged

Consolidate shared info between README.md and DESCRIPTION.rst #590

merged 5 commits into from
Apr 29, 2025

Conversation

vzhurba01
Copy link
Collaborator

@vzhurba01 vzhurba01 commented Apr 29, 2025 •
edited
Loading

Description

closes #300

  • Designates DESCRIPTION.rst files for pypi package description. They describe the package and provide forwards users to further documentation using links.
  • Designates README.md as a more in-depth description of the pages. In addition to providing the package description and documentation links, it also mentions development practices and running tests.
  • Moves shared project development practices to CONTRIBUTING.md
  • Omits linter changes since that will be covered in Add lint instructions #581

Checklist

  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@vzhurba01 vzhurba01 added documentation Improvements or additions to documentation P1 Medium priority - Should do cuda.bindings Everything related to the cuda.bindings module cuda.core Everything related to the cuda.core module labels Apr 29, 2025
@vzhurba01 vzhurba01 added this to the cuda.core beta 4 milestone Apr 29, 2025
@vzhurba01 vzhurba01 self-assigned this Apr 29, 2025
@copy-pr-bot copy-pr-bot
Copy link
Contributor

copy-pr-bot bot commented Apr 29, 2025

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@vzhurba01
Copy link
Collaborator Author

/ok to test 25493b0

@vzhurba01 vzhurba01 requested review from rwgk and leofang April 29, 2025 17:58
@vzhurba01
Copy link
Collaborator Author

/ok to test 3eaa044

@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@vzhurba01
Copy link
Collaborator Author

/ok to test 4affc86

kkraus14
kkraus14 reviewed Apr 29, 2025
View reviewed changes
@vzhurba01
Copy link
Collaborator Author

/ok to test 9eafeee

@kkraus14 kkraus14 merged commit 5404764 into NVIDIA:main Apr 29, 2025
75 checks passed
@github-actions GitHub Actions
Copy link

Doc Preview CI
Preview removed because the pull request was closed or merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kkraus14 kkraus14 kkraus14 approved these changes

@rwgk rwgk Awaiting requested review from rwgk

@leofang leofang Awaiting requested review from leofang

Assignees

@vzhurba01 vzhurba01

Labels
cuda.bindings Everything related to the cuda.bindings module cuda.core Everything related to the cuda.core module documentation Improvements or additions to documentation P1 Medium priority - Should do
Projects
None yet
Milestone
cuda.core beta 4
Development

Successfully merging this pull request may close these issues.

Consolidate DESCRIPTION.rst and README.md
2 participants
@vzhurba01 @kkraus14