API Version History & Compatibility Table in Documentation #12663
akhrarovsaid
started this conversation in
Feature Requests & Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Payload is moving at the speed of light. We're 40+ minor versions deep since the launch of 3.0.0 - with every release since then introducing significantly more capabilities and features. This makes it difficult for many users to stay on top of all of the changes that occur. For example, it's not clear when certain config properties were introduced which leads to confusion for end users when they try to use those properties on Payload versions that do not support them.
I think Payload should introduce an API Versioning / Compatibility table / Badge to the docs. These tables / badges would denote when specific properties were introduced into Payload by surfacing the Payload version that it is associated with.
Many languages/libraries/frameworks do this and I've listed a few examples below.
Beta Was this translation helpful? Give feedback.
All reactions