Skip to content

Improve README documentation clarity #11682

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

Open
amahi1568 wants to merge 1 commit into
base: master
Choose a base branch
from
+1 −1
Open

Improve README documentation clarity #11682

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Apache Maven
- [3.9.x](https://github.com/apache/maven/tree/maven-3.9.x): [![Maven Central](https://img.shields.io/maven-central/v/org.apache.maven/apache-maven.svg?label=Maven%20Central&versionPrefix=3.)](https://central.sonatype.com/artifact/org.apache.maven/apache-maven)


Apache Maven is a software project management and comprehension tool. Based on
Apache Maven is a software project management and build automation tool. Based on
Copy link
Member

@slawekjaranowski slawekjaranowski Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we use such sentence in many place .... I would like to first discuss, confirm it on ML
Next we should change it globally

Copy link
Contributor

@elharo elharo Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've discussed it before. I'd prefer not to let the perfect be the enemy of the good. Fixing one awkward, unclear doc out of 100 is better than leaving it alone while we figure out how to fix the other 99. Since we're not a mono-repo we'll never fix them all at the same time anyway.

the concept of a project object model (POM), Maven can manage a project's
build, reporting and documentation from a central piece of information.

Expand Down