Repository navigation
docs: align supported platform requirements - #688
Draft
dajiaohuang wants to merge 1 commit into
Draft
dajiaohuang wants to merge 1 commit into
dajiaohuang wants to merge 1 commit into
Conversation
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
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.
Why
The README advertises iOS 17+ / macOS 14+, but
Package.swiftrequires iOS 18 / macOS 15 and Swift tools 6.2. The lower minimums mislead consumers about which deployment targets the package supports.The approach
Align the README requirements with the package: Xcode 26+, Swift 6.2, iOS 18+ / macOS 15+.
Testing
py -3 scripts/check-doc-links.pypassed across 28 Markdown files;git diff --checkpassed.bin/lint --fixand--checkwere attempted but this Windows environment is unsupported by the script (it ships macOS arm64 and Linux x86_64 builds only). Swift tests were not run for this README-only change; the PR's Linux lint workflow will check the document.Learnings
None.
Earned its keep: AGENTS.md § Docs: contracts rather than snapshots — Package.swift owns platform targets; README owns public usage.