Fix API documentation links in README.md#490
Conversation
|
@swift-ci test |
|
Note that the latest stable release is on the |
Good point, however In this PR I propose for README.md on the main branch specifically to always point to the latest stable release, since this is the main readme that most users of this library see. I opened this PR because I've been in this situation multiple times: I search online for swift-collections -> I land on Github with main branch open by default -> I click API docs link in README.md -> a webpage opens for an outdated release and I have to manually switch to the latest. I feel like it would be more convenient to always see the latest documentation. Another alternative would be to keep every branch pointing to its own documentation (main points to main, release/1.2 to 1.2.x, etc.), but it would create additional maintenance cost to update these versions and it would send most people to main branch docs that is not what they usually want. |
|
Yeah, I think this is fine. Landing this on release/1.2 would still make it appear on main (due to the (manual) propagation of changes from 1.2 → main), but this is not really worth arguing about. Thanks for catching this! |
As of today the latest public release is 1.2.0 so API docs links in README.md are outdated, they still point to 1.1.0.
To avoid the maintenance cost of keeping URLs up to date this PR removes library version from URLs, making them always point to the latest stable release instead.
Another alternative would be to point URLs to the main branch (example), however for most of developers this README.md is the main entry point when installing the library and they would except to see docs for the latest stable release.
Checklist