Skip to content

docs: expand CarPlay documentation in README#1690

Merged
garthvh merged 1 commit into
2.7.11from
copilot/add-carplay-feature-documentation
Apr 24, 2026
Merged

docs: expand CarPlay documentation in README#1690
garthvh merged 1 commit into
2.7.11from
copilot/add-carplay-feature-documentation

Conversation

Copilot AI commented Apr 24, 2026

Copy link
Copy Markdown
Contributor

What changed?

Replaced the brief CarPlay stub in README.md with comprehensive documentation covering the full feature surface.

New sections added:

  • Requirements — iOS 16+, CarPlay hardware/simulator, connected device, Siri authorization
  • Interface — Two-tab layout (Channels + Direct Messages), per-row detail (unread badges, last-heard timestamps), disconnected state, Favorites vs. Recent DM sections
  • Siri Voice Commands — Expanded table with example phrases and descriptions; limitations callout (200-byte cap, single-recipient-only, emoji/admin message exclusions)
  • Incoming Message Announcements — Siri read-back behaviour, 50-message unread backfill at session start
  • Live Activity — Dynamic Island/Lock Screen widget contents and lifecycle
  • Architecture Notes (For Developers) — File-to-role mapping table for all CarPlay/Intents components; notes on debounced isConnected observer and per-session intent-donation de-duplication

Why did it change?

The CarPlay feature was added without adequate documentation. The previous README section was 13 lines covering only a surface-level feature list and an intent-name table, with no requirements, setup steps, UI description, limitations, or developer guidance.

How is this tested?

Documentation-only change; verified by reading the rendered Markdown.

Screenshots/Videos (when applicable)

N/A

Checklist

  • My code adheres to the project's coding and style guidelines.
  • I have conducted a self-review of my code.
  • I have commented my code, particularly in complex areas.
  • I have verified whether these changes require an update to existing documentation or if new documentation is needed, and created an issue in the docs repo if applicable.
  • I have tested the change to ensure that it works as intended.

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@garthvh garthvh marked this pull request as ready for review April 24, 2026 04:48
@garthvh garthvh merged commit 92a2c65 into 2.7.11 Apr 24, 2026
1 check was pending
@garthvh garthvh deleted the copilot/add-carplay-feature-documentation branch April 24, 2026 04:52
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.

3 participants