Skip to content

Fix API documentation links in README.md#123

Merged
lorentey merged 1 commit into
apple:mainfrom
azarovalex:fix-api-docs
Jul 9, 2025
Merged

Fix API documentation links in README.md#123
lorentey merged 1 commit into
apple:mainfrom
azarovalex:fix-api-docs

Conversation

@azarovalex

Copy link
Copy Markdown
Contributor

As of today the latest public release is 1.3.0 so API docs links in README.md are outdated.
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

  • I've read the Contribution Guidelines
  • My contributions are licensed under the Swift license.
  • I've followed the coding style of the rest of the project.
  • I've added tests covering all new code paths my change adds to the project (if appropriate).
  • I've verified that my change does not break any existing tests.
  • I've updated the documentation if necessary.

@lorentey lorentey merged commit a53de94 into apple:main Jul 9, 2025
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants