Skip to content

Add Antora-based documentation - #336

Open
marcphilipp wants to merge 13 commits into
assertj:mainfrom
marcphilipp:antora
Open

marcphilipp wants to merge 13 commits into
assertj:mainfrom
marcphilipp:antora

Conversation

@marcphilipp

@marcphilipp marcphilipp commented Nov 13, 2026 •

Copy link
Copy Markdown

Migrate the AssertJ DB user guide from assertj/doc to an Antora component in src/docs/antora. The component version and the assertj-db-version attribute are taken from the project's pom.xml, and the included example is compiled with the test sources.

The concepts and features chapters are split into one page per section. The images from img now live in the component, and the README points at the icon there.

./mvnw antora generates the site locally, as described in the new "Documentation" section of the contributing guidelines. The CI workflow builds the site and uploads it as an artifact, and Dependabot updates the npm dependencies.

Part of

Migrate the AssertJ DB user guide from assertj/doc to an Antora
component in `docs`. The component version and the
`assertj-db-version` attribute are taken from `docs/pom.xml`, which
also compiles the included example.

Build the site in the CI workflow and let Dependabot update the Maven
and npm dependencies of `docs`.
Break the two long pages of the user guide into one page per section,
`concepts/*.adoc` and `features/*.adoc`, and nest them in the
navigation. Cross-references now point at the new pages.
@marcphilipp

Copy link
Copy Markdown
Author

Supersedes

@VanRoy VanRoy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hi @marcphilipp , Thanks a lot.

Just few minor comments.
In addition can you also delete *.dia files not really useful anymore.

Comment thread src/docs/antora-resources/antora.yml Resolved
@marcphilipp

Copy link
Copy Markdown
Author

In addition can you also delete *.dia files not really useful anymore.

Done in 8c04d67

@marcphilipp
marcphilipp requested a review from VanRoy November 20, 2026 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants