adding changes to mark rocm/dgl deprecated, retaining original readme…#25
Merged
adding changes to mark rocm/dgl deprecated, retaining original readme…#25
Conversation
… as a separate file
jamesETsmith
approved these changes
Apr 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This change retires the main project README in favor of a short deprecation notice and keeps the previous full README as a reference copy.
Changes
README.md — Replaced the long ROCm/DGL readme with a minimal deprecation banner: a “Deprecation warning” heading, a GitHub [!CAUTION] callout, and a link to the upstream repository (dmlc/dgl) so visitors are directed there instead of treating this repo as the primary home for ROCm/DGL docs.
README-deprec.md — Added as a snapshot of the former README.md content (full historical readme: ROCm install options, Docker, build-from-source, and the standard DGL upstream sections) so nothing is lost from version control history while the default landing page is the warning.
Rationale
Communicate clearly that the ROCm/dgl repository is retired and steer users to upstream DGL, without deleting the old documentation from the tree.