Expand CLAUDE.md with comprehensive inline documentation #995
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
Replace brief reference to AGENT_README.md with complete inline documentation including build/test workflows, project structure, common task recipes, and AI agent memory system. Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #995 +/- ##
==========================================
- Coverage 69.78% 69.77% -0.02%
==========================================
Files 111 111
Lines 8983 8983
==========================================
- Hits 6269 6268 -1
- Misses 2714 2715 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Ayyanchira
approved these changes
Jan 13, 2026
Member
Ayyanchira
left a comment
Ayyanchira
left a comment
There was a problem hiding this comment.
Approved with some small optional suggestions. Would love to see how it makes difference 👍🏼
Comment on lines
+150
to
+152
| - Create in `swift-sdk/Core/Models/YourModel.swift` | ||
| - Make it `@objcMembers public class` for Objective-C compatibility | ||
| - Implement `Codable` if it needs JSON serialization |
Member
There was a problem hiding this comment.
This is nice! More specific the expectation, better will be the output!
| ### 📍 Code Location Map | ||
| - **Auth Logic**: `swift-sdk/Internal/AuthManager.swift` (main auth manager), `swift-sdk/Internal/Auth.swift` (auth models) | ||
| - **API Calls**: `swift-sdk/Internal/api-client/ApiClient.swift` (main client), `swift-sdk/Internal/Network/NetworkHelper.swift` (networking) | ||
| - **Models**: `swift-sdk/Core/Models/` (all data structures - CommerceItem, IterableInAppMessage, etc.) |
Member
There was a problem hiding this comment.
Probably good to add Public facing methods go in IterableApi.swift class. Its implementation is in ApiClient.swift class.
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.
What
Replaces the brief reference to AGENT_README.md with a complete, self-contained documentation file that AI agents can use directly without needing to read separate files.
Changes
Impact
Testing
How to test: