Skip to content

docs: document supported versions#151

Merged
paodb merged 1 commit intomasterfrom
supported-versions
Mar 17, 2026
Merged

docs: document supported versions#151
paodb merged 1 commit intomasterfrom
supported-versions

Conversation

@javier-godoy
Copy link
Member

@javier-godoy javier-godoy commented Mar 13, 2026

Summary by CodeRabbit

  • Documentation
    • Added "Supported versions" reference documenting compatibility between Vaadin releases and add-on versions.

@coderabbitai
Copy link

coderabbitai bot commented Mar 13, 2026

Walkthrough

A new "Supported versions" documentation section was added to the README with a table mapping Vaadin versions to corresponding add-on versions. This is a content-only update with no code modifications.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added "Supported versions" section with a table mapping Vaadin versions (24-25 → add-on 5.x, 14-23 → add-on 3.x).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title accurately describes the main change: adding documentation for supported versions to the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch supported-versions
📝 Coding Plan
  • Generate coding plan for human review comments

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 and usage tips.

@sonarqubecloud
Copy link

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
README.md (1)

9-12: Optional: clarify whether add-on 4.x is intentionally not supported.

A short note below the table would prevent confusion for users upgrading across major versions.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 9 - 12, Add a short clarifying note below the
versions table in README.md stating whether add-on 4.x is intentionally
unsupported or what users on Vaadin versions that would map to 4.x should do
(e.g., upgrade path, compatibility info, or rationale). Reference the versions
table header ("Vaadin Version | Add-on Version") and the rows for "24-25 | 5.x"
and "14-23 | 3.x" when placing the note so readers understand why 4.x is
omitted.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.md`:
- Around line 9-12: Add a short clarifying note below the versions table in
README.md stating whether add-on 4.x is intentionally unsupported or what users
on Vaadin versions that would map to 4.x should do (e.g., upgrade path,
compatibility info, or rationale). Reference the versions table header ("Vaadin
Version | Add-on Version") and the rows for "24-25 | 5.x" and "14-23 | 3.x" when
placing the note so readers understand why 4.x is omitted.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ad30a943-ccb0-442a-8628-818b876264bc

📥 Commits

Reviewing files that changed from the base of the PR and between 2d8a8ee and 6e197fe.

📒 Files selected for processing (1)
  • README.md

@javier-godoy javier-godoy marked this pull request as ready for review March 13, 2026 19:49
@paodb paodb merged commit 2f2b5f2 into master Mar 17, 2026
3 checks passed
@paodb paodb deleted the supported-versions branch March 17, 2026 20:21
@github-project-automation github-project-automation bot moved this from To Do to Pending release in Flowing Code Addons Mar 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Pending release

Development

Successfully merging this pull request may close these issues.

2 participants