Description
Context
When adding new props, we end up with user on an existing project that try them and get errors, because they are in a version that does not yet support this prop
For example we got a feedbacks about
I have an typescript error
"TS2322: Type '{ timezone: string; slots: { openPickerIcon: any; }; className: string; label: string; value: null; onChange: (e: null) => void; }' is not assignable to type 'IntrinsicAttributes & DateTimePickerProps<null> & RefAttributes<HTMLDivElement>'. Property 'timezone' does not exist on type 'IntrinsicAttributes & DateTimePickerProps<null> & RefAttributes<HTMLDivElement>'
when trying to utilize "timezone" prop.
Some problems
The main issues I see is the timeline. We have no idea about which version will contain the feature we are developing.
A solution could be that PR add some token such as DATA_GRID_VERSION and during the release phase those get replaced by the release version
Potential solution
1 Automated API update
When running docs:api the script could search for the oldest tag associated to the commit that introduced the tag.
2 Manual update
We could have a tag in JSdocs to set the version
3 Manual update in the demo page
The first entry point of docs is the demo, not the API, so we might whant to be able to add a small information about the version in which the feature got introduced. Could be some token in the title to set it
Benchmark
- Ant Design. has a
versioncolumn in its API table. https://ant.design/components/date-picker#common-api
