We're avoiding versioning the dbc docs, since that would add a lot of complexity.
To help with this, @amoeba added a nice "since_version" badge in #263. This will help users to see that they need to upgrade to a newer version of dbc to use certain features.
But this leaves another problem unsolved: If we merge docs PRs long before we're ready to release, and those docs PRs document new features, then:
- If we use this badge, it will contain a broken link (to the release that doesn't exist yet) and it might mislead users into thinking that the release exists when it doesn't.
- If we don't apply this badge to the newly added features until we're ready for release, then users won't know that those features are new and not available in the latest stable release.
An elegant way to solve this would be to make the "since_version" badge render differently in the build process or in the frontend if the version it points to is not yet released.
If that's not feasible, a less fancy alternative would be to add a separate badge to mark new, unreleased changes, and then swap that out for the "since_version" bade when we're ready to release.
Whichever approach we use, maybe the badge could say something like "unreleased" or "coming soon" and render in a different color?
We're avoiding versioning the dbc docs, since that would add a lot of complexity.
To help with this, @amoeba added a nice "since_version" badge in #263. This will help users to see that they need to upgrade to a newer version of dbc to use certain features.
But this leaves another problem unsolved: If we merge docs PRs long before we're ready to release, and those docs PRs document new features, then:
An elegant way to solve this would be to make the "since_version" badge render differently in the build process or in the frontend if the version it points to is not yet released.
If that's not feasible, a less fancy alternative would be to add a separate badge to mark new, unreleased changes, and then swap that out for the "since_version" bade when we're ready to release.
Whichever approach we use, maybe the badge could say something like "unreleased" or "coming soon" and render in a different color?