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

Update per-Python package README files across RAPIDS #70

Open
vyasr opened this issue Jun 4, 2024 · 0 comments
Open

Update per-Python package README files across RAPIDS #70

vyasr opened this issue Jun 4, 2024 · 0 comments
Assignees

Comments

@vyasr
Copy link
Contributor

vyasr commented Jun 4, 2024

Currently Python projects in RAPIDS contain README files that are simply symlinks to the top-level READMEs. This approach was taken during the initial wheels spike because that was the easiest way to generate reasonably suitable READMEs for every package. The build backends that we use (setuptools and scikit-build-core) support symlinked READMEs, so the actual README is properly pulled into wheels when the packages are built. However, this approach has a couple of drawbacks

  1. The READMEs often contain invalid links when viewed through the Github GUI because the relative paths are all wrong.
  2. The READMEs contain information that isn't strictly relevant to the package at hand because the top-level READMEs encompass all components of the repo, including other Python packages as well as C++ libraries.

To resolve this issues, I would propose that we write separate README files for each Python package. To minimize the risk of these going stale, we should aim to minimize the contents of READMEs and attempt to link out to other resources as much as possible so that there remains a single source of truth for information as much as possible.

Note that for conda packages the README isn't relevant since only installed components of the Python package end up included in the conda package anyway, so

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants