Repository navigation
Add Antora-based documentation - #336
Open
marcphilipp wants to merge 13 commits into
Open
marcphilipp wants to merge 13 commits into
marcphilipp wants to merge 13 commits into
Conversation
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.
Author
|
Supersedes |
VanRoy
requested changes
Nov 19, 2026
VanRoy
left a comment
Member
There was a problem hiding this comment.
Hi @marcphilipp , Thanks a lot.
Just few minor comments.
In addition can you also delete *.dia files not really useful anymore.
The documentation is published per release, so "Since x.y.z" markers and notes about imports for versions before 3.0.2 are no longer needed.
Author
Done in 8c04d67 |
VanRoy
approved these changes
Nov 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Migrate the AssertJ DB user guide from assertj/doc to an Antora component in
src/docs/antora. The component version and theassertj-db-versionattribute are taken from the project'spom.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
imgnow live in the component, and the README points at the icon there../mvnw antoragenerates 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