Skip to content

docs: add incoming call kit plugin pages#548

Open
riderx wants to merge 2 commits intomainfrom
codex/add-incoming-call-kit-docs
Open

docs: add incoming call kit plugin pages#548
riderx wants to merge 2 commits intomainfrom
codex/add-incoming-call-kit-docs

Conversation

@riderx
Copy link
Copy Markdown
Member

@riderx riderx commented Mar 31, 2026

Summary

  • register the new Incoming Call Kit plugin in the website plugin registry
  • add docs index, getting started, iOS, and Android pages plus the plugin icon
  • add the plugin card, sidebar/search entries, and the SEO tutorial page

Validation

  • bunx prettier --check astro.config.mjs src/config/plugins.ts src/content/docs/docs/plugins/index.mdx src/content/docs/docs/plugins/incoming-call-kit/*.mdx src/content/plugins-tutorials/en/capacitor-incoming-call-kit.md public/icons/plugins/incoming-call-kit.svg
  • git diff --check

Notes

  • I attempted both the local Astro build and Astro check flows, but both hung after Astro initialized the repo's Cloudflare integrations in this environment, so I used targeted file validation instead.

Summary by CodeRabbit

  • Documentation

    • Added a full Incoming Call Kit docs set: overview, getting started, iOS and Android guides, and an English tutorial. Sidebar and docs navigation updated to include the new plugin.
  • New Features

    • Added the Incoming Call Kit plugin to the platform — native incoming-call presentation with iOS CallKit support and Android high-priority/full-screen notification behavior.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 31, 2026

📝 Walkthrough

Walkthrough

Adds site configuration and documentation for the @capgo/capacitor-incoming-call-kit plugin: sidebar/docs entries in astro.config.mjs, a plugin registry entry in src/config/plugins.ts, multiple MDX docs (overview, getting-started, iOS, Android), an index LinkCard, and a tutorial page.

Changes

Cohort / File(s) Summary
Site config
astro.config.mjs
Added Starlight sidebar entry and customSets entry for the Incoming Call Kit docs under docs/plugins/incoming-call-kit/**.
Plugin registry
src/config/plugins.ts
Appended a new plugin object for @capgo/capacitor-incoming-call-kit to the exported actions array (name, author, description, href, title, icon).
Plugin docs
src/content/docs/docs/plugins/incoming-call-kit/index.mdx, src/content/docs/docs/plugins/incoming-call-kit/getting-started.mdx, src/content/docs/docs/plugins/incoming-call-kit/ios.mdx, src/content/docs/docs/plugins/incoming-call-kit/android.mdx
Added overview, getting-started, and platform-specific (iOS/Android) guides with usage examples, permissions notes, and platform behavior details.
Index & tutorial
src/content/docs/docs/plugins/index.mdx, src/content/plugins-tutorials/en/capacitor-incoming-call-kit.md
Inserted Incoming Call Kit LinkCard into plugins index and added an English tutorial/quick-start guide describing installation, API usage, and platform notes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰 I hopped through docs and config bright,
To plant a ring that glows at night,
CallKit whispers, phones reply,
Incoming Calls beneath the sky 🥕📞✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding documentation pages for the incoming call kit plugin. It is concise, specific, and directly reflects the primary purpose of the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/add-incoming-call-kit-docs

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/content/docs/docs/plugins/incoming-call-kit/index.mdx`:
- Around line 19-20: Update the hero action label's capitalization by replacing
the YAML key value "text: Github" with "text: GitHub" in the plugin docs (the
same block containing the associated link value
"https://github.com/Cap-go/capacitor-incoming-call-kit/"); ensure only the label
is changed and the link value remains untouched.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f0ea35be-1494-4870-a303-e1cf67dcd475

📥 Commits

Reviewing files that changed from the base of the PR and between aaaa4c0 and 803cb20.

⛔ Files ignored due to path filters (1)
  • public/icons/plugins/incoming-call-kit.svg is excluded by !**/*.svg
📒 Files selected for processing (8)
  • astro.config.mjs
  • src/config/plugins.ts
  • src/content/docs/docs/plugins/incoming-call-kit/android.mdx
  • src/content/docs/docs/plugins/incoming-call-kit/getting-started.mdx
  • src/content/docs/docs/plugins/incoming-call-kit/index.mdx
  • src/content/docs/docs/plugins/incoming-call-kit/ios.mdx
  • src/content/docs/docs/plugins/index.mdx
  • src/content/plugins-tutorials/en/capacitor-incoming-call-kit.md

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Apr 2, 2026

Quality Gate Failed Quality Gate failed

Failed conditions
100.0% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
src/content/docs/docs/plugins/incoming-call-kit/index.mdx (1)

31-31: Optional: Consider simplifying "on top of that."

The phrase "on top of that" is slightly wordy. You could tighten it to "atop that" or omit it entirely for a more concise sentence. As per coding guidelines, LanguageTool flagged this as potentially verbose (EN_WORDINESS_PREMIUM_ON_TOP_OF_THAT).

✂️ Proposed alternatives

Option 1 (omit entirely):

-Use it when you already have your own signaling flow, SIP stack, Twilio integration, Stream integration, FCM delivery, or PushKit delivery and you want the platform-native incoming call experience on top of that.
+Use it when you already have your own signaling flow, SIP stack, Twilio integration, Stream integration, FCM delivery, or PushKit delivery and you want the platform-native incoming call experience.

Option 2 (use "atop that"):

-Use it when you already have your own signaling flow, SIP stack, Twilio integration, Stream integration, FCM delivery, or PushKit delivery and you want the platform-native incoming call experience on top of that.
+Use it when you already have your own signaling flow, SIP stack, Twilio integration, Stream integration, FCM delivery, or PushKit delivery and you want the platform-native incoming call experience atop that.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/content/docs/docs/plugins/incoming-call-kit/index.mdx` at line 31,
Replace the phrase "on top of that" in the sentence that begins "Use it when you
already have your own signaling flow, SIP stack, Twilio integration, Stream
integration, FCM delivery, or PushKit delivery and you want the platform-native
incoming call experience on top of that." with a more concise alternative
(either remove it entirely or use "atop that") so the sentence reads more
concise while preserving meaning.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@src/content/docs/docs/plugins/incoming-call-kit/index.mdx`:
- Line 31: Replace the phrase "on top of that" in the sentence that begins "Use
it when you already have your own signaling flow, SIP stack, Twilio integration,
Stream integration, FCM delivery, or PushKit delivery and you want the
platform-native incoming call experience on top of that." with a more concise
alternative (either remove it entirely or use "atop that") so the sentence reads
more concise while preserving meaning.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cfdeebb8-ecf9-40e9-abfa-634a7a6e0954

📥 Commits

Reviewing files that changed from the base of the PR and between 803cb20 and cda884e.

📒 Files selected for processing (1)
  • src/content/docs/docs/plugins/incoming-call-kit/index.mdx

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant