Fix API documentation links in README.md - #258
Merged
Merged
Conversation
rnro
enabled auto-merge (squash)
June 30, 2025 09:21
rnro
approved these changes
Jun 30, 2025
Lukasa
disabled auto-merge
June 30, 2025 13:56
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR removes
mainbranch name from API docs URLs, making them always point to the latest stable release instead of the main branch.For most of developers this README.md is the main entry point when installing the library, so pointing them to API docs for the latest stable release makes more sense then the main branch which may contain un-released API or breaking changes.