fix(docs): include components at different version stages in versioned docs#2464
fix(docs): include components at different version stages in versioned docs#2464
Conversation
…d docs The version map stored a single componentVersion per package per library version, determined by the first import found in the export file. This excluded components that haven't been migrated to v2 (e.g. DateInput2) from v11_7 docs, because the export file also imports DateInput/v2 and only that first match was recorded. Changed to collect all component versions referenced in each export file so packages with mixed v1/v2 components are correctly included.
|
HerrTopi
force-pushed
the
fix/docs-version-map-multi-version
branch
from
808e4a6 to
c12c609
Compare
HerrTopi
force-pushed
the
fix/docs-version-map-multi-version
branch
from
c12c609 to
8fcebce
Compare
matyasf
left a comment
matyasf
left a comment
There was a problem hiding this comment.
Looks good, but hard to understand, I've added some comments about documentation
| --- | ||
|
|
||
| > _Note:_ we recommend to update to the new [`DateInput2`](/#DateInput2) which is easier to configure for developers, has a better UX, better accessibility features and a year picker. `DateInput` will be deprecated in the future. | ||
| > _Info_: If you are migrating from the deprecated [`DateInput2`](/v11_6/DateInput2), this `DateInput` component has the same API — you can switch with no code changes. |
There was a problem hiding this comment.
We will need an old DateInput -> new DateInput migration guide. Also versions here are hard to understand, maybe make a short table?
v11.6 DateInput: Old API, old theming. Deprecated, a11y issues
v11.6 DateInput2: new API, old theming. Deprecated. Cannot use the new themes.
v11.7 DateInput: new API, new theming. Good a11y, works with the new themes
| --- | ||
|
|
||
| > _Info_: `DateInput2` is an upgrade to the [`DateInput`](/#DateInput) component, offering easier configuration, better UX, improved accessibility, and a year picker. Please consider updating to this for WCAG compatiblity and an overall better experience (for both devs and users). | ||
| > **Deprecated:** `DateInput2` is deprecated and will not receive further updates. Its functionality has been merged into the latest version of [`DateInput`](/v11_7/DateInput) which has the same API. Please migrate to `DateInput` for continued support. |
There was a problem hiding this comment.
We must mention here, that this component does NOT work with the new themes (because it uses old components internally)
| --- | ||
|
|
||
| > _Note:_ we recommend to update to the new [`DateInput2`](/#DateInput2) which is easier to configure for developers, has a better UX, better accessibility features and a year picker. `DateInput` will be deprecated in the future. | ||
| > **Deprecated:** This version of `DateInput` is deprecated. Please use the latest version of [`DateInput`](/v11_7/DateInput) which offers easier configuration, better UX, improved accessibility, and a year picker. |
There was a problem hiding this comment.
I would write here more details about versions and compatibility. Also we will need an old DateInput -> new DateInput migration guide.
Also versions here are hard to understand, maybe make a short table?
v11.6 DateInput: Old API, old theming. Deprecated, a11y issues
v11.6 DateInput2: new API, old theming. Deprecated. Cannot use the new themes.
v11.7 DateInput: new API, new theming. Good a11y, works with the new themes
HerrTopi
force-pushed
the
fix/docs-version-map-multi-version
branch
from
8fcebce to
d9b9789
Compare
3 participants
The version map stored a single componentVersion per package per library version, determined by the first import found in the export file. This excluded components that haven't been migrated to v2 (e.g. DateInput2) from v11_7 docs, because the export file also imports DateInput/v2 and only that first match was recorded.
Changed to collect all component versions referenced in each export file so packages with mixed v1/v2 components are correctly included.
Also migrated DateInput and DateInput2 the following way:
DateInput/v1 =>deprecated
DateInput/v2 => DateInput2, updated
DateInput2/v1 => deprecated