Repository navigation
docs: pain-first README hook + Jekyll site for GitHub Pages - #27
Conversation
Rewrite the opening of README.md to mirror the language real users search for: the airport CLI removal in macOS 14.4, the BSSID redaction in wdutil, and the CoreWLAN signed-Developer-ID requirement that scripts can't satisfy. Cite the Apple DTS forum thread that confirms the constraint. Also reference macwifi-cli for users who just want the airport replacement on the terminal.
Three-page documentation site under docs/ ready to be served at
jaisonerick.github.io/macwifi:
- index.md home page with the problem statement, install,
and a minimal example
- getting-started.md
long-form guide covering the Location Services
prompt, the Network struct, password retrieval,
and troubleshooting
- how-it-works.md
architecture: the embedded signed helper, why
CoreWLAN linked into Go via CGo can't replace it,
and the wire protocol between Go and Swift
Uses the just-the-docs remote theme via _config.yml so GitHub
Pages can build it directly from main:/docs with no Ruby
dependencies on our side.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: cb26c262b6
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - The first `Scan()` or `Password()` call will trigger the macOS | ||
| Location Services prompt. There is no API to suppress this — it's | ||
| the entire reason the library can return real BSSIDs. |
There was a problem hiding this comment.
This states that the first Password() call triggers the macOS Location Services prompt, but the current implementation only requests Location authorization in the scan path (runScan/ensureAuthorized) and password lookups use Keychain APIs directly. In a password-only integration, users will wait for a prompt that never appears and may build incorrect onboarding/error handling around that assumption.
Useful? React with 👍 / 👎.
1 participant
Summary
Two documentation changes to support the OSS launch:
README hook revision — leads with the language real users search
for (the
airportremoval in macOS 14.4, theBSSID : <redacted>output from
wdutil, and the CoreWLAN signed-Developer-IDrequirement that scripts can't satisfy). Cites the Apple DTS forum
thread that confirms the constraint. Adds a pointer to the new
macwifi-clicompanion for users who just want a terminal command.Jekyll documentation site under
docs/— three pages ready tobe served at
jaisonerick.github.io/macwifionce Pages is enabled:index.md— landing with problem, install, minimal examplegetting-started.md— long-form guide covering Location Servicesdance, the
Networkstruct, password retrieval, andtroubleshooting
how-it-works.md— architecture: signed helper, why CGo can'treplace it, and the wire protocol between Go and Swift
Uses the
just-the-docsremote theme via_config.ymlso GitHubPages can build it directly from
main:/docswithout us shippingRuby dependencies.
Background research and source quotes that drove the rewrite are in
~/code/jaisonerick/second-brain/studio/macwifi/launch/.Test plan