This looks really nice, thx for the work ! One question that comes to my mind is whether it would make sense to have the documentation inside the maven-core project. The main reason is that a single PR can then modify the code along with the documentation. Having them separate is a barrier to documentation updates imho. So the same way we merged the ITs inside apache/maven repo, I propose we include the doc sources in that repo and add the generation as part of the build. Have you already discussed that ?
Le jeu. 22 oct. 2026 à 18:56, Sandra Parsick <[email protected]> a écrit : > > Hi, > > In the context of Support & Care [1], we create a proof of concept of > how modern Maven documentation could look: https://docs.maven-starter.io/ > > Many pages have dummy content because we want to see what kind of > structure could work for us. But some pages already have content to find > out what kind of different documentation style could look like, for example: > - Your first Maven build in 5 minutes [2] > - What is Maven (for)? [3] > - How to add and exclude dependencies [4] > - Write your first Maven 3 plugin in Java [5] > - The dependency mechanism [6] > - Installing Apache Maven [7] > > We have also invested time in writing a guide [8] and describing how an > information architecture [9] for Maven could look for it, so > > We have opened a GitHub discussion [10] if you want to give us feedback. > > We are also planning to add more content to it in the future. > > Cheers, > Sandra > > [1] https://open-elements.com/support-care > [2] https://docs.maven-starter.io/app-developer/getting-started/first-build/ > [3] https://docs.maven-starter.io/app-developer/key-concepts/what-maven-is/ > [4] > https://docs.maven-starter.io/app-developer/how-to/add-exclude-dependencies/ > [5] > https://docs.maven-starter.io/plugin-developer/tutorials/first-java-plugin/ > [6] > https://docs.maven-starter.io/app-developer/key-concepts/dependency-mechanism/ > [7] https://docs.maven-starter.io/about/installation/ > [8] > https://github.com/support-and-care/doc-for-maven/blob/main/writing-guide.md > [9] > https://github.com/support-and-care/doc-for-maven/blob/main/information-architecture.md > [10] https://github.com/support-and-care/doc-for-maven/discussions > > -- > ======================= > Freelancer | Software Developer | Java Champion > > Mastodon: @[email protected] > Codeberg: https://codeberg.org/sparsick > Github: https://www.github.com/sparsick > Blog: https://blog.sandra-parsick.de > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [email protected] > For additional commands, e-mail: [email protected] > -- ------------------------ Guillaume Nodet --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
