Skip to content

docs: add migration guide for binding generator from 3.x to 4.x#1302

Merged
anavarr merged 1 commit intosmallrye:mainfrom
anavarr:docs/migration-guide-3x-4x
Mar 4, 2026
Merged

docs: add migration guide for binding generator from 3.x to 4.x#1302
anavarr merged 1 commit intosmallrye:mainfrom
anavarr:docs/migration-guide-3x-4x

Conversation

@anavarr
Copy link
Contributor

@anavarr anavarr commented Feb 26, 2026

No description provided.

@anavarr anavarr force-pushed the docs/migration-guide-3x-4x branch from efac0d0 to 8db9134 Compare February 26, 2026 15:00
Copy link
Member

@jponge jponge left a comment

Choose a reason for hiding this comment

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

Good start!

See my comments

@anavarr anavarr force-pushed the docs/migration-guide-3x-4x branch from 5db2012 to 2012bbf Compare February 27, 2026 15:29
Copy link
Member

@jponge jponge left a comment

Choose a reason for hiding this comment

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

I think we should have a link to the generated compatibility report, so users have the option to get the tiny details.

The report itself doesn't need to be in the sidebar links, but it should be a link of this page.

@anavarr anavarr requested a review from jponge March 3, 2026 14:06
@anavarr anavarr force-pushed the docs/migration-guide-3x-4x branch from 71b87f5 to 7e3034a Compare March 3, 2026 15:20
Copy link
Member

@jponge jponge left a comment

Choose a reason for hiding this comment

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

You should be consistent between the mkdocs.yml and document title. "Upgrading from version 3 to 4" is good for both IMHO

@anavarr anavarr force-pushed the docs/migration-guide-3x-4x branch from 7e3034a to 4484e94 Compare March 3, 2026 16:47
@jponge jponge marked this pull request as ready for review March 3, 2026 18:31
@jponge
Copy link
Member

jponge commented Mar 3, 2026

@anavarr "Commits must have verified signatures." (you can force push, no worries)

Copy link
Member

@jponge jponge left a comment

Choose a reason for hiding this comment

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

Sounds good otherwise

@anavarr anavarr force-pushed the docs/migration-guide-3x-4x branch from 5f817c9 to 06bf0c3 Compare March 4, 2026 09:20
- details how the new generator is a full CLI instead of an annotation processing tool
- add links to 'using the generator' in index and in migration guide
- augment 'using the generator' with a tip explaining how additional sources are useful

Co-authored-by: Julien Ponge <julien.ponge@outlook.com>
@anavarr anavarr force-pushed the docs/migration-guide-3x-4x branch from 06bf0c3 to 2c83c5d Compare March 4, 2026 09:27
@jponge
Copy link
Member

jponge commented Mar 4, 2026

Go ahead @anavarr 🥳

@anavarr anavarr merged commit 1b94840 into smallrye:main Mar 4, 2026
3 checks passed
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