Fix inaccurate public-facing claims - #9
Open
AadhilFarhan wants to merge 1 commit into
Open
Conversation
- README promised "Apple silicon or Intel" support. The review downloaded the actual v0.1.0 release DMG and ran lipo -info on the binary inside: it's arm64-only. release.yml builds with no --arch flags and no lipo step, so every release from the current pipeline is arm64-only, not a one-off. Corrected the claim rather than building a universal binary, per user's call — bigger CI cost and DMG size for Intel support nobody's asked for yet. - docs/index.html's footer said "Portside runs entirely on your Mac," inherited near-verbatim from GhostPin's site, where it's true (GhostPin has zero network code). It's not true for Portside: the headline QR-share feature explicitly relays traffic to another device over the LAN, which the same page's own "How sharing works" section and the README both correctly describe. Reworded to match the README's already-accurate framing.
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.
What
Two factual defects in public-facing docs, both found by actually checking claims against reality rather than trusting the text:
README promised Intel support the shipped binary doesn't have. Downloaded the real, published
v0.1.0release DMG and ranlipo -infoon the binary inside — it'sarm64only.release.ymlbuilds with no--archflags and nolipostep, so this isn't a one-off; every release from the current pipeline is arm64-only. Per your call, corrected the claim rather than building a universal binary (bigger CI cost and DMG size for Intel support nobody's asked for).docs/index.html's footer overclaimed privacy. "Portside runs entirely on your Mac" was inherited near-verbatim from GhostPin's site, where it's literally true (zero network code). It's not true for Portside — the headline QR-share feature explicitly relays traffic to another device over the LAN, which the same page's own "How sharing works" section (and the README) already describe correctly. Reworded the footer to match the README's already-accurate framing instead of contradicting the rest of the same page.Test plan