-
Notifications
You must be signed in to change notification settings - Fork 0
feat(ios): add NSE setup guide with SDK-aligned implementation #9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Update NotificationService.swift template to use ClixNotificationServiceExtension - Add CocoaPods and SPM dependency setup instructions for extension target - Add ENABLE_USER_SCRIPT_SANDBOXING build setting guidance for Xcode 15+ - Add NSE setup section to install skill for consistency - Regenerate embedded-skills.ts with updated local skills
WalkthroughAdds iOS Notification Service Extension setup and integration instructions across docs and prompts, simplifies the NotificationService.swift scaffold to call Clix SDK registration, reorders extension setup steps and build-setting guidance, and inserts new embedded skills entries in the registry. Changes
Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: dc4028f7e7
ℹ️ 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".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@src/lib/embedded-skills.ts`:
- Around line 1971-1990: Add the two new skills (folder/name/commandName values:
auditing-deep-link-contracts and auditing-permission-ux) to the README.md and
llms.txt docs: insert interactive command entries for
/auditing-deep-link-contracts and /auditing-permission-ux in the interactive
skills section with short descriptions matching the code ("Audits deep link
contracts and routing behavior" and "Audits notification permission request
flows"), and update any summary counts and command listing text that say "5
interactive skills" to "7 interactive skills" (overview and command listing) so
documentation matches the new entries.
In `@src/lib/ios/agent-prompt-generator.ts`:
- Around line 56-90: The docs show two different extension target names causing
a mismatch: update all occurrences (the Podfile target
'${context.appName}NotificationServiceExtension' and the entitlements path
'${context.iosDir}/NotificationServiceExtension/NotificationServiceExtension.entitlements',
plus any SPM/Xcode steps) to use a single consistent placeholder like
'${context.notificationExtensionTarget}' (or another agreed variable), and
ensure examples (Podfile snippet, entitlements path, and SPM step text)
reference that same symbol so the user’s chosen extension target name is
consistent across Steps 2, 4, and 5.
Remove alternative target name option to prevent mismatch between Podfile target, entitlements path, and actual extension target name.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@src/lib/skills/ios-setup/SKILL.md`:
- Line 161: The README contains a bare URL "https://console.clix.so/" which
triggers markdownlint MD034; update the line in SKILL.md (the note that says
"Replace `YOUR_PROJECT_ID` with your actual Clix project ID from
https://console.clix.so/") to use a proper Markdown link or angle-bracketed URL
(for example "from [Clix Console](https://console.clix.so/)" or "from
<https://console.clix.so/>") so the bare-URL lint error is resolved.
- Around line 131-185: The README.md and llms.txt need explicit mention that the
ios-setup skill now includes a full Notification Service Extension (NSE) setup;
update README.md to expand the short description ("Configure iOS
capabilities...") to list NSE setup steps/coverage (creating the Notification
Service Extension target, implementing NotificationService.swift using
ClixNotificationServiceExtension and register(projectId: "..."), Podfile/SPM
instructions, and Xcode build setting notes) and update llms.txt to include NSE
as a distinct component under /ios-setup (mention NotificationService.swift, the
target name convention like {AppName}NotificationServiceExtension, dependency
instructions, and ENABLE_USER_SCRIPT_SANDBOXING guidance) so downstream docs and
prompts reflect the new major feature.
- Update README.md ios-setup section with NSE setup details - Update llms.txt with comprehensive NSE configuration guide - Fix bare URL markdown lint issue in SKILL.md
|
Looking good! Let me know when it's ready for the test. I want to try this one. |
Summary
Add comprehensive Notification Service Extension (NSE) setup guidance to iOS-related commands, aligning with the official Clix iOS SDK documentation.
Details
Changes:
NotificationService.swifttemplate to useClixNotificationServiceExtensioninheritance (SDK README-aligned)register(projectId:)API call in the templateENABLE_USER_SCRIPT_SANDBOXINGbuild setting guidance for Xcode 15+installskill for consistency across commandsembedded-skills.tswith updated local skillsFiles modified:
src/lib/ios/agent-prompt-generator.ts- Core NSE template and instructionssrc/lib/skills/ios-setup/SKILL.md- Phase 3.5 NSE setup sectionsrc/lib/skills/install/SKILL.md- NSE reference sectionsrc/lib/embedded-skills.ts- Auto-regeneratedRelated Issues
Related to SDK documentation sync: https://docs.clix.so/sdk-ios-nse
How to Validate
DEBUG=1 bun run dev ios-setupand verify the agent prompt includes:ClixNotificationServiceExtensioninheritanceregister(projectId: "YOUR_PROJECT_ID")callENABLE_USER_SCRIPT_SANDBOXINGbuild setting noteDEBUG=1 bun run dev installand verify NSE section appears in outputbun run check- should pass with existing warnings onlybun test- unit tests should pass (E2E tests require build)Pre-Merge Checklist
Code Quality
bun run build)bun run typecheck)bun run lint)bun test)Documentation
Commit Standards
Platform Validation
Summary by CodeRabbit
New Features
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.