Improve README structure and documentation #281
Merged
Conversation
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
Malax
added
the
skip changelog
edmorley
approved these changes
Dec 2, 2025
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.
This PR restructures the README to reduce duplication with Dev Center documentation and improve clarity, inspired by the approach taken in the Heroku Python buildpack.
The title now explicitly includes the build tool name to clarify which buildpack is appropriate for different JVM projects. The naming of these buildpacks can make it hard to discover what they are actually used for and compatible with. Links to related buildpacks (Java for Maven, Gradle, Scala for sbt, and Clojure for Leiningen) have been added to help users find the right buildpack for their project.
Documentation that was duplicated from Dev Center has been removed, including detailed setup instructions, examples, and version-specific information that becomes outdated. The README now links to the appropriate Dev Center category rather than listing individual articles.
The configuration section has been simplified into a scannable table format for environment variables, with links to Dev Center for detailed instructions rather than duplicating that content.
GUS-W-20400218