[codex] add install referrer plugin docs#642
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds the ChangesInstall Referrer Plugin Onboarding
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
apps/docs/src/content/docs/docs/plugins/install-referrer/getting-started.mdx (1)
42-49: ⚡ Quick winConsider showing the structure of
appleAttributionor linking to detailed iOS docs.The example accesses
result.appleAttributionbut doesn't show what data it contains. Adding a brief comment or example of the returned structure would help users understand what to expect, or reference the iOS-specific documentation page for details.Example enhancement:
// result.appleAttribution contains the parsed Apple attribution response // See ios.mdx for the complete data structure console.log(result.appleAttribution);🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@apps/docs/src/content/docs/docs/plugins/install-referrer/getting-started.mdx` around lines 42 - 49, Add a brief inline comment and/or link showing the shape of the returned apple attribution data so readers know what to expect: update the InstallReferrer.getReferrer example to include a short comment above the console.log describing that result.appleAttribution contains the parsed Apple attribution response (list key fields like source/app/ad_id/timestamp or a note to see the iOS docs) and optionally add a link to the iOS docs or ios.mdx for the full schema; reference the InstallReferrer.getReferrer call and the result.appleAttribution property when adding this comment.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In
`@apps/docs/src/content/docs/docs/plugins/install-referrer/getting-started.mdx`:
- Around line 42-49: Add a brief inline comment and/or link showing the shape of
the returned apple attribution data so readers know what to expect: update the
InstallReferrer.getReferrer example to include a short comment above the
console.log describing that result.appleAttribution contains the parsed Apple
attribution response (list key fields like source/app/ad_id/timestamp or a note
to see the iOS docs) and optionally add a link to the iOS docs or ios.mdx for
the full schema; reference the InstallReferrer.getReferrer call and the
result.appleAttribution property when adding this comment.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 54ba5c6c-4098-4c01-a900-439edb252708
📒 Files selected for processing (10)
apps/docs/src/config/llmsCustomSets.tsapps/docs/src/config/sidebar.mjsapps/docs/src/content/docs/docs/plugins/install-referrer/android.mdxapps/docs/src/content/docs/docs/plugins/install-referrer/getting-started.mdxapps/docs/src/content/docs/docs/plugins/install-referrer/index.mdxapps/docs/src/content/docs/docs/plugins/install-referrer/ios.mdxapps/web/src/config/plugins.tsapps/web/src/content/plugins-tutorials/en/capacitor-install-referrer.mdapps/web/src/data/github-stars.jsonapps/web/src/data/npm-downloads.json
|
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
1 participant
What
Adds the new
@capgo/capacitor-install-referrerplugin to the website registry, plugin docs sidebar, LLM docs sets, metadata files, and English tutorial content.Why
The plugin is now published in the Cap-go GitHub org and needs website/docs coverage for Android Google Play Install Referrer and iOS Apple AdServices attribution support.
Validation
bunx prettier --write apps/web/src/config/plugins.ts apps/docs/src/config/sidebar.mjs apps/docs/src/config/llmsCustomSets.ts apps/docs/src/content/docs/docs/plugins/install-referrer/index.mdx apps/docs/src/content/docs/docs/plugins/install-referrer/getting-started.mdx apps/docs/src/content/docs/docs/plugins/install-referrer/android.mdx apps/docs/src/content/docs/docs/plugins/install-referrer/ios.mdx apps/web/src/content/plugins-tutorials/en/capacitor-install-referrer.md apps/web/src/data/github-stars.json apps/web/src/data/npm-downloads.jsonbun run checkSummary by CodeRabbit
Documentation
Chores