I find having a "single page" view especially useful for searching
documentation, like JUnit does.

I also really like the PostgreSQL docs feature, where the top of the page
lets you select the specific version you want to view.

Ty!
Gary


On Wed, Oct 28, 2026, 09:43 Delany <[email protected]> wrote:

> Hi,
>
> Complete coverage is essential: I need to know I am looking at the entire
> body of documentation so that if a solution isn't found, I'm confident
> raising it on the forum.
>
> No need to reinvent the wheel here - is there a better documentation model
> to follow than JUnit?
> https://docs.junit.org/6.1.3/overview.html
>
> Kind regards,
> Delany
>
>
> On Thu, 22 Oct 2026 at 18:54, Sandra Parsick <[email protected]> wrote:
>
> > 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]
> >
> >
>

Reply via email to