[agentic-pim]

Why

• The generated Javadoc landing page currently offers no introduction or clear route into the assertion API.

How

• Add javadoc/overview.html and configure the existing aggregate Javadoc report to use it.
• Highlight LightkeeperAssertions, show a complete JUnit test and an asynchronous assertion example, and link the main API entry points and documentation site.

Tests

• mvn clean verify install -Perrorprone -Dmaven.javadoc.skip=true checkstyle:checkstyle pmd:check jacoco:report -Dgoal=helpmojo — passed with JDK 21.0.10 and Maven 3.9.9; 1,264 unit tests and 130 integration tests (65 each on Paper and Spigot), no failures.
• mvn -Pdefault,docs site:site — passed.
• Verified all 14 overview API links and anchors and compiled both examples extracted from the generated page with JDK 21.0.10.

Documentation

• This PR changes the generated Javadoc overview only; the public API, setup, and runtime behavior are unchanged. No companion website PR is needed: the existing publisher deploys the generated overview under javadoc/ on gh_pages. The documentation site's pages and assets are unaffected.
• No public API change; docs/assertion-coverage.md is unaffected.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration

• Source mode: Auto
• Repository: Unavailable
• Branch: Unavailable
• File: No configuration file from this repository applied
• Commit: Unavailable
• Layers: Repository UI
• Review profile: CHILL
• Plan: Advanced
• Run ID: e59d675b-2474-4436-994d-04e7350a4317

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• Trigger review

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Tip

🎯 Customize your risk assessments

Guide how CodeRabbit assesses merge risk and security architecture risk. Highlight sensitive changes and explain your security boundaries using Merge Risk Instructions and Security Risk Instructions in your review settings. Security architecture risk assessments require the Advanced plan or above.

✅ Automatic approvals, with your rules

Let CodeRabbit approve pull requests once required threads are resolved, pre-merge checks pass, and your risk limits are met. Enable Automatic approvals in review settings, with overrides for teams or file paths.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

• X
• Mastodon
• Reddit
• LinkedIn

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!