chore: updated package docs

[greenfrvr]

🎫 Ticket: https://linear.app/stream/issue/RN-374/update-callingx-docs

Summary by CodeRabbit

• Documentation
  • Simplified README introducing the native-calling bridge as core concept
  • Updated quick-start setup configuration with new API method references
  • Reorganized API documentation with updated main APIs and lifecycle entry points
  • Restructured event documentation into explicit call and VoIP event categories
  • Added notes on updated import paths and platform-specific helper functions

[changeset-bot]

⚠️ No Changeset found

Latest commit: a2b43ca

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

📝 Walkthrough

Walkthrough

The README for the react-native-callingx package was substantially simplified, reducing from comprehensive setup instructions and extensive examples to a concise overview highlighting iOS CallKit and Android Telecom/ConnectionService integration. Quick-start configuration, API surface, and event documentation were condensed while deprecated APIs were removed.

Changes

Cohort / File(s)

Summary

README Documentation packages/react-native-callingx/README.md

Simplified package branding to "native-calling bridge" overview. Removed detailed OS requirements, setup procedures, permissions flow, and usage examples. Updated quick-start configuration with ios.callsHistory, modified Android channel naming, and removed optional sound/vibration examples. Condensed API documentation to core methods (updateDisplay, getInitialVoipEvents, registerBackgroundTask, startBackgroundTask, stopBackgroundTask). Restructured event documentation into explicit "Call events" and "VoIP events" lists. Added Notes section documenting import path and platform-specific helpers.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A README reimagined, clear and bright,
From lengthy tales to focused light,
The bridge now shines in simpler dress,
iOS CallKit and Android—nothing less! ✨

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description only contains a Linear ticket reference and lacks the required Overview and Implementation notes sections from the template.	Add an Overview section explaining why the docs were updated and an Implementation notes section describing the key changes made to the README.
Title check	❓ Inconclusive	The title 'chore: updated package docs' is vague and generic, using non-descriptive terms that don't convey meaningful information about the specific documentation changes.	Revise the title to be more specific about what package documentation was updated (e.g., 'chore: simplify react-native-callingx README with API overview').

✅ Passed checks (1 passed)

Check name	Status	Explanation
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 callingx-docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

🧹 Nitpick comments (1)

packages/react-native-callingx/README.md (1)

62-62: Document the startBackgroundTask(taskProvider?) overload to match implementation.

README currently implies no-arg only, but CallingxModule.startBackgroundTask(taskProvider?: ManagableTask) accepts an optional provider. This can mislead integrators and hide a supported usage path.

✏️ Suggested doc fix

-- `registerBackgroundTask(taskProvider)` / `startBackgroundTask()` / `stopBackgroundTask()` (Android).
+- `registerBackgroundTask(taskProvider)` / `startBackgroundTask(taskProvider?)` / `stopBackgroundTask()` (Android).

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@packages/react-native-callingx/README.md` at line 62, The README line
describing background task APIs is misleading: update the doc entry for
startBackgroundTask to show the overload that accepts an optional provider
(CallingxModule.startBackgroundTask(taskProvider?: ManagableTask)), describe the
parameter type (ManagableTask) and what happens when you pass a provider vs call
with no args, and keep registerBackgroundTask(...) and stopBackgroundTask()
mentioned alongside for clarity. Mention expected behavior/side-effects briefly
(e.g., provider used to create/manage the background work) so integrators know
this usage is supported.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@packages/react-native-callingx/README.md`:
- Line 62: The README line describing background task APIs is misleading: update
the doc entry for startBackgroundTask to show the overload that accepts an
optional provider (CallingxModule.startBackgroundTask(taskProvider?:
ManagableTask)), describe the parameter type (ManagableTask) and what happens
when you pass a provider vs call with no args, and keep
registerBackgroundTask(...) and stopBackgroundTask() mentioned alongside for
clarity. Mention expected behavior/side-effects briefly (e.g., provider used to
create/manage the background work) so integrators know this usage is supported.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0597cb67-4f0e-42fc-baf1-0f2e2051b8ab

📥 Commits

Reviewing files that changed from the base of the PR and between d287dd4 and a2b43ca.

📒 Files selected for processing (1)

• packages/react-native-callingx/README.md