really nice is it possible to have an "edit" link on each page to easily go the the .md source?
and is there an idea/a plan on how to have documentation for each plugin and every Maven sub-project? Or is it intended to focus only on Maven core / maven-site? Le jeudi 22 octobre 2026, 22:08:49 heure d’été d’Europe centrale Gerd Aschemann a écrit : > Yes, yes, yes! Docs should live close to the respective code IMHO! > > > On 22. Oct 2026, at 21:01, Guillaume Nodet <[email protected]> wrote: > > > > 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-dependenci > >> es/ [5] > >> https://docs.maven-starter.io/plugin-developer/tutorials/first-java-plugi > >> n/ > >> [6] > >> https://docs.maven-starter.io/app-developer/key-concepts/dependency-mecha > >> nism/ [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-a > >> rchitecture.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] > > -- > Gerd Aschemann --- Veröffentlichen heißt Verändern (Carmen Thomas) > +49/173/3264070 -- [email protected] -- http://www.aschemann.net --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
