Repository navigation
README v2 and AGENTS.md: quickstart first, docs links, agent guidance - #90
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configuration
You can disable this status message by setting the Use the checkbox below for a quick retry:
Comment |
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
SpertsyanKM
left a comment
There was a problem hiding this comment.
Thanks, Vlada — snippets, minimum versions, pins, links and the MCP destructive-tool flow check out against main. Changes needed before merge:
This repo
Approve-level, a few points to consider:
- README.md:136 / AGENTS.md:109 — "supported: 7.x and 8.x":
peerDependenciesallow 7, but CI only builds Capacitor 8 consumer apps. Suggest "8 (CI-tested); 7.x allowed by peerDependencies, not tested" — same policy as cordova-ios 6. - README.md:139 / AGENTS.md:109 (nit) —
compileSdk 35is a fallback default in android/build.gradle:27, overridden by the app; not a hard minimum. - AGENTS.md:32 (nit) — what is pinned exactly is
QonversionSandwich7.14.0; reword. - Repo description and topics: OK.
Shared with the other README v2 / AGENTS.md PRs
- Apple Ads availability — my earlier guidance is outdated, sorry. After 2026-10-09, mcp-server #126 (DEV-1480) removed the separate write beta: there is no
apple_ads_writeaccount gate any more (mcp-server/internal/tools/apple_ads_write.go:134). Writes need theapple_adsaccount feature, theapple_ads:writescope, a dashboard member with campaign-management permission and Apple org write access, and can be switched off server-side. "Closed beta — ask support to switch it on" sends agents the wrong way. Until Sam finalises the Apple Ads docs, please use neutral wording, e.g.: "Apple Ads tools need the feature on your account (404 otherwise); campaign changes additionally need theapple_ads:writescope and a team member with campaign-management permission — checkget_apple_ads_connection_status." - AGENTS.md "If the three disagree, the docs page wins". For the version the docs page lags (iOS page says 6.17.0, Flutter 11.11.0, Unity 9.10.0 and "2018.3", Android
9.+, Cordova still lists cordova-ios 6.x; Web/RN pages name no version). Make the release tag / package registry authoritative for the version, docs for API usage, and tell the agent to report a mismatch. Same for the integration prompt line "use the SDK version the docs name".
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
@SpertsyanKM thanks for the review. All points are addressed in 6ee6bd0 — could you take another look? This repo
Shared with the other README v2 / AGENTS.md PRs
Repo description is left to you, as agreed. Not merging from our side. |
SpertsyanKM
left a comment
There was a problem hiding this comment.
Re-reviewed 6ee6bd0 — all round-1 points are fixed (Capacitor 8 CI-tested / 7.x allowed, compileSdk 35 as fallback, QonversionSandwich 7.14.0 pin, Apple Ads, version source). Verified against package.json peerDependencies, checks.yml, android/build.gradle, the podspec and Package.swift; latest tag = npm latest = 1.10.0.
Approving. Feel free to merge once the PR body is updated — besides the Apple Ads sentence (see below), the body still lists @capacitor/core 7.x–8.x (→ "8 (CI-tested); 7.x allowed by peerDependencies") and compileSdk 35 as a requirement (drop it).
Shared across all nine README v2 / AGENTS.md PRs
- PR body before squash-merge. The body still says reading Apple Ads "is on for all accounts" and changing campaigns "is a closed beta per account". Both are outdated (mcp-server#126). The body becomes the squash commit message, so please update that sentence, or replace the commit body when merging, e.g.: "Apple Ads in MCP: tools need the
apple_adsaccount feature; campaign changes additionally need theapple_ads:writescope and campaign-management permission (mcp-server#126)." - "A refused Apple Ads call means missing access … do not retry" (AGENTS.md). Slightly too absolute:
get_apple_ads_connection_statuscan reportcampaign_management.state: unknown(permission snapshot not landed yet — try later), and an Apple authorization can need reauthorization. Suggested: "A refused Apple Ads call usually means missing access or an Apple authorization that needs attention, not a broken server: callget_apple_ads_connection_status, do not work around it, and tell the human what it reports." Non-blocking; can go together with Sam's final Apple Ads wording.
Summary
Files:
README.md,AGENTS.md.checkEntitlements/entitlements). The mode is named out loud, with a link to Analytics Mode.llms.txt, the Qonversion MCP server with the Apple Ads read/write split, the two-step confirmation for destructive tools, and the integration prompt (same text as in the docs).AGENTS.mdfor coding agents: how to get the current version instead of one from memory, install, init, first call, docs as markdown, MCP, and what an agent must not do without the human saying yes (keys, mode, live project configuration, destructive MCP tools, environment).Removed on purpose: the Analytics / A/B Experiments / Integrations / Why Qonversion? sections (they duplicate the website and push the install below the fold); long platform guides → a link into the docs; all images except the header.
Facts checked
Minimum versions, from this repository's manifests:
@capacitor/core7.x–8.x —package.jsonPackage.swiftminSdkVersion23 ·compileSdk35 —android/build.gradleInit and first-call signatures:
example/src/app/main.ts,src/QonversionApi.ts,example/src/app/screens/EntitlementsScreen.ts.Versions:
npm installcarries no version. Latest release on 2026-10-12: 1.10.0.Header image
The approved header (logo and platform list, no positioning text) ships in this PR as
.github/assets/sdk-header.png, referenced by a one-line<img>tag on line 1 with a relative path, which GitHub, npm and pub.dev all resolve. The quickstart line count does not move.Links
All 30 URLs in these files checked with
curl -sI -Lon 2026-10-12: 27 return 200, the rest are expected:401https://mcp.qonversion.io/mcp — OAuth endpoint of the MCP server, expected without a token403https://www.npmjs.com/package/@qonversion/capacitor-plugin — npmjs.com blocks automated requests; the package exists (checked via registry.npmjs.org)405https://documentation.qonversion.io/mcp — the docs MCP endpoint does not answer GET, it speaks MCPLICENSEexists in this repository (hygiene PRs merged 2026-10-09/10).docs/for-agentsis live.Review
Four independent reviews in the marketing hub (product, marketing, QA, brand), two iterations. Maintainer answers of 2026-10-09 applied here: Apple Ads in MCP: reading is on for all accounts, changing campaigns is a closed beta per account; the
discard_*docs-gap note removed fromAGENTS.md.Reviewer: @SpertsyanKM — the review request cannot be set from a fork, hence the mention.
Repository description (settings, not a file)
The repository description shown under the name on GitHub is a setting, so it cannot be part of this PR. Proposed text to set when merging, so the description, the README header and the docs say the same thing:
Current: Capacitor plugin for cross-platform (iOS and Android) in-app purchase and subscription infrastructure, revenue analytics, engagement automation, and integrations
One command for a maintainer:
gh repo edit qonversion/capacitor-plugin --description "Qonversion Capacitor plugin: iOS and Android purchases confirmed with the stores, entitlements, and the revenue data behind Apple Ads, A/B tests and analytics.". Capacitor has no topics yet; suggested, by analogy with Cordova:capacitor,capacitor-plugin,in-app-purchases,subscriptions,storekit,google-billing,receipt-validation.🤖 Generated with Claude Code