Skip to content

REL 1.30 - Update documentation#68

Open
MaximPlusov wants to merge 2 commits into
masterfrom
rel
Open

REL 1.30 - Update documentation#68
MaximPlusov wants to merge 2 commits into
masterfrom
rel

Conversation

@MaximPlusov

@MaximPlusov MaximPlusov commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Chores
    • Updated product/version details to 1.30.2 across release metadata and documentation.
  • Documentation
    • Refreshed installer documentation to focus on the Greenfield implementation and streamlined what the installer includes/where files are located.
    • Updated developer and plugin Maven setup instructions to 1.30.2.
    • Clarified CLI metadata-fixing behavior and removed version-only language; updated GUI “Fix Metadata” checkbox wording.
    • Simplified an example note in the processor API documentation.

@coderabbitai

coderabbitai Bot commented Jun 18, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@MaximPlusov, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 26 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9ef9bac6-9fc9-4732-bc4c-cbcae6b53e65

📥 Commits

Reviewing files that changed from the base of the PR and between 75ee997 and 4e02734.

📒 Files selected for processing (8)
  • _config.yml
  • cli/fixing/index.md
  • cli/validation/index.md
  • develop/index.md
  • gui/index.md
  • install/index.md
  • plugins/index.md
  • policy/info-dict/report.xml
📝 Walkthrough

Walkthrough

The site version and release metadata are updated to 1.30.2. Installation, developer, processor, CLI, GUI, and plugin documentation are revised, including updated dependency versions, installer examples, and Greenfield-related guidance.

Changes

Version and documentation updates

Layer / File(s) Summary
Release versions and metadata
_config.yml, develop/index.md, plugins/index.md, policy/info-dict/report.xml
Updates configured and documented versions to 1.30.2, adjusts the plugin dependency range, and refreshes release metadata and build dates.
Installer documentation
install/index.md
Simplifies implementation, contents, and installation-layout descriptions and updates automated-installation pack selections and four-step sample output.
Greenfield and metadata-fixing guidance
develop/index.md, develop/processor/index.md, cli/fixing/index.md, gui/index.md
Removes PDFBox setup guidance and Greenfield-only metadata-fixing qualifiers while simplifying the processor example comment.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the release documentation update and the 1.30 version bump.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch rel

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

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
install/index.md (1)

97-99: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Align the automated-installation example with the package selection. In install/index.md, veraPDF Sample Plugins is deselected in the XML (selected="false"), but the sample output still shows it as [ Processing package: veraPDF Sample Plugins (4/4) ]. Either select the pack or change the output to stop at 3/3.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@install/index.md` around lines 97 - 99, Align the automated-installation
example by making the package selection and sample output consistent: either set
the veraPDF Sample Plugins pack to selected="true" and retain the 4/4 output, or
keep it deselected and update the output to stop at 3/3.
🧹 Nitpick comments (1)
develop/index.md (1)

44-54: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Improve phrasing and grammar.

Consider adjusting the phrasing for better readability and grammatical correctness by adding the missing article before "alternative dependency" and replacing "accordingly" with "respectively".

💡 Proposed text improvements
-The implementation above depends on javax. If your project uses jakarta, you should use alternative dependency:
+The implementation above depends on javax. If your project uses jakarta, you should use the alternative dependency:
 
 ```xml
 <dependency>
   <groupId>org.verapdf</groupId>
   <artifactId>validation-model-jakarta</artifactId>
   <version>1.30.2</version>
 </dependency>

-If your project uses core or verapdf-library dependencies, they also have alternative jakarta versions (core-jakarta or verapdf-library-jakarta accordingly).
+If your project uses core or verapdf-library dependencies, they also have alternative jakarta versions (core-jakarta and verapdf-library-jakarta respectively).

</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @develop/index.md around lines 44 - 54, Improve the dependency guidance
prose: add the missing article before “alternative dependency” in the
javax/jakarta explanation, and update the final sentence to pair core-jakarta
with core and verapdf-library-jakarta with verapdf-library using
“respectively” instead of “accordingly.”


</details>

<!-- cr-comment:v1:4754fe36db333abf518b86af -->

</blockquote></details>

</blockquote></details>

<details>
<summary>🤖 Prompt for all review comments with AI agents</summary>

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In @install/index.md:

  • Around line 97-99: Align the automated-installation example by making the
    package selection and sample output consistent: either set the veraPDF Sample
    Plugins pack to selected="true" and retain the 4/4 output, or keep it deselected
    and update the output to stop at 3/3.

Nitpick comments:
In @develop/index.md:

  • Around line 44-54: Improve the dependency guidance prose: add the missing
    article before “alternative dependency” in the javax/jakarta explanation, and
    update the final sentence to pair core-jakarta with core and
    verapdf-library-jakarta with verapdf-library using “respectively” instead of
    “accordingly.”

</details>

---

<details>
<summary>ℹ️ Review info</summary>

<details>
<summary>⚙️ Run configuration</summary>

**Configuration used**: defaults

**Review profile**: CHILL

**Plan**: Pro

**Run ID**: `5d6f1f2e-6f13-4bb4-8783-0df9862d2ba6`

</details>

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between eefebad451600afb6651c5fcc1b8b808d276b10c and 75ee997cb919999f5014a9e8af2d889e0c25f5cd.

</details>

<details>
<summary>📒 Files selected for processing (7)</summary>

* `_config.yml`
* `cli/fixing/index.md`
* `develop/index.md`
* `gui/index.md`
* `install/index.md`
* `plugins/index.md`
* `policy/info-dict/report.xml`

</details>

<details>
<summary>🚧 Files skipped from review as they are similar to previous changes (1)</summary>

* _config.yml

</details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

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.

1 participant