Repository navigation
docs(project): align docs with the package, add demo showcase - #11
Merged
Merged
Conversation
Audit found the docs contradicting Package.swift and each other; reconcile everything to ground truth. - Correct the dependency story (one dependency: swift-atomics, not zero) in CLAUDE.md, and add refreshMetrics() to the public contract. - Fix README badges (Swift 6.0, Apache 2.0 license), add a Showcase section near the top with a screenshot comparison table (iPhone 12 vs iPhone 17 Pro Max) and a privacy-manifest note. - Rewrite PLATFORM_SUPPORT.md: drop removed APIs (ResponsiveInsets, ResponsiveFontDescriptor), fix platform floors to iOS 15 / macOS 12 / tvOS 15 / watchOS 8, and the safe-area/default values. - Update CONTRIBUTING.md project structure, file-naming (PascalCase) and toolchain prerequisites. - Trim the fictional unreleased 1.0.0 changelog entry. - Strip EXIF metadata from the demo screenshots before committing.
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
1 participant
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.
Audit found the docs contradicting Package.swift and each other; reconcile everything to ground truth.