Unify project description in README, docs, and metadata - #2178
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the project’s short description across the repository so README, docs site metadata, and published artifact metadata communicate Shadow’s broader scope (fat/uber JARs, transforms/relocation, and R8/ProGuard optimization).
Changes:
- Refresh project tagline in the root README.
- Update MkDocs
site_descriptionto match the new tagline. - Update Maven POM description metadata in
gradle.properties. - Simplify the docs “Introduction” description accordingly.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Updates the top-level project description/tagline. |
| mkdocs.yml | Updates MkDocs site metadata (site_description) to match the new description. |
| gradle.properties | Updates POM_DESCRIPTION used for published artifact metadata. |
| docs/README.md | Updates the documentation introduction text to match the new description. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Goooler
changed the title
Goooler
commented
Aug 10, 2026
Co-authored-by: Zongle Wang <wangzongler@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.
Suppressed comments (2)
README.md:4
- The new tagline is a sentence fragment (missing a verb). Under the README heading it reads a bit awkwardly; consider making it a complete sentence (e.g., starting with “Shadow is …”).
A Gradle plugin for creating fat/uber JARs, transforming files, relocating packages, and optimizing applications
with R8/ProGuard. The Gradle counterpart to Maven's Shade plugin.
docs/README.md:8
- This introduction sentence is currently a fragment (it lacks a verb). Consider changing it to a full sentence (e.g., starting with “Shadow is …”) for smoother reading in the docs.
A Gradle plugin for creating fat/uber JARs, transforming files, relocating packages, and optimizing applications
with R8/ProGuard. The Gradle counterpart to Maven's Shade plugin.
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
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.
No description provided.