Skip to content

[codex] add capacitor auto plugin docs#713

Merged
riderx merged 2 commits into
mainfrom
codex/add-capacitor-auto
May 21, 2026
Merged

[codex] add capacitor auto plugin docs#713
riderx merged 2 commits into
mainfrom
codex/add-capacitor-auto

Conversation

@riderx
Copy link
Copy Markdown
Member

@riderx riderx commented May 21, 2026

What changed

  • Added @capgo/capacitor-auto to the website plugin registry with a car-oriented icon.
  • Added docs pages for Auto overview, getting started, iOS CarPlay setup, and Android Auto setup.
  • Added the English plugin tutorial and refreshed GitHub/npm metadata caches.

Why

@capgo/capacitor-auto is now published under the Cap-go organization, so the website should expose the plugin, docs, and tutorial entry points.

Validation

  • bunx prettier --write on touched config/docs/tutorial files
  • GITHUB_STATS_REFRESH=true bun run fetch:stars
  • NPM_DOWNLOADS_REFRESH=true bun run fetch:downloads
  • bun run check

Summary by CodeRabbit

  • New Features

    • Added listing and UI metadata for the new Capacitor Auto plugin (CarPlay/Android Auto).
  • Documentation

    • Added main plugin page, Getting Started guide, and platform-specific iOS/Android setup docs.
    • Added a web tutorial describing installation, template usage, events, and connection handling.
  • Chores

    • Updated plugin registry/config and icon mapping.
    • Refreshed GitHub star/stats and npm download data.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 21, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: a787ae23-3fbe-4197-ada3-b8ec887a87f0

📥 Commits

Reviewing files that changed from the base of the PR and between 4f9a824 and 75b510d.

📒 Files selected for processing (1)
  • apps/docs/src/content/docs/docs/plugins/auto/index.mdx

📝 Walkthrough

Walkthrough

This PR adds comprehensive documentation and registry support for the @capgo/capacitor-auto plugin, which bridges Capacitor apps to Apple CarPlay and Android Auto platforms. The changes register the plugin across documentation and web configurations, provide getting started guides, platform-specific setup instructions, and update plugin metrics data.

Changes

Capacitor Auto Plugin Documentation & Registration

Layer / File(s) Summary
Plugin Registry Configuration
apps/docs/src/config/llmsCustomSets.ts, apps/docs/src/config/sidebar.mjs, apps/web/src/config/plugins.ts
Plugin @capgo/capacitor-auto is registered in the docs LLM custom set index, added to sidebar navigation with iOS/Android links, and integrated into the web plugin registry with Truck icon mapping.
Core Plugin Documentation
apps/docs/src/content/docs/docs/plugins/auto/index.mdx, apps/docs/src/content/docs/docs/plugins/auto/getting-started.mdx, apps/web/src/content/plugins-tutorials/en/capacitor-auto.md
Overview page describes the template-based car UI model and core API (isAvailable, setRootTemplate, sendMessage, connectionChanged, carAction, messageReceived); getting started guide covers installation, sync, template setup, event listeners, and connection state tracking; web tutorial mirrors guidance with TypeScript examples and design principles.
Platform-Specific Setup Documentation
apps/docs/src/content/docs/docs/plugins/auto/ios.mdx, apps/docs/src/content/docs/docs/plugins/auto/android.mdx
iOS guide details Info.plist scene configuration and entitlement requirements; Android guide explains AndroidX Car App Library, manifest service declaration, default IOT category configuration, template sync behavior, and rendering constraints.
Statistics & Metrics Data Updates
apps/web/src/data/github-stars.json, apps/web/src/data/github-stats.json, apps/web/src/data/npm-downloads.json
GitHub star counts refreshed for multiple plugin repositories; top-level aggregate stats and per-repository metrics (contributors, versions, releases, issues, PRs) updated; npm download counts refreshed with new entries for @capgo/capacitor-auto and existing packages.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

  • Cap-go/website#656: Adds a different plugin entry to the same plugin registries and docs wiring (same files modified; different plugin).
  • Cap-go/website#642: Modifies the plugin registry and sidebar entries to add another plugin; similar registry/docs changes.
  • Cap-go/website#685: Extends plugin registration configs and updates statistics data files for a different plugin.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title '[codex] add capacitor auto plugin docs' directly and accurately summarizes the main changes: adding documentation for the capacitor-auto plugin to the website.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.


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

@riderx riderx marked this pull request as ready for review May 21, 2026 15:04
@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

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 current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@apps/docs/src/content/docs/docs/plugins/auto/index.mdx`:
- Around line 44-52: The three bullet descriptions for the events
connectionChanged, carAction, and messageReceived all start with "fires" which
reads repetitively; update those three lines to vary sentence structure (for
example use "Emitted when...", "Triggered when...", or "Occurs when...") while
preserving the meaning and linking each phrase to the correct event name
(`connectionChanged`, `carAction`, `messageReceived`).
🪄 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: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: a843af0a-4422-4253-968c-7d9cb6809e0d

📥 Commits

Reviewing files that changed from the base of the PR and between 23f5a52 and 4f9a824.

📒 Files selected for processing (11)
  • apps/docs/src/config/llmsCustomSets.ts
  • apps/docs/src/config/sidebar.mjs
  • apps/docs/src/content/docs/docs/plugins/auto/android.mdx
  • apps/docs/src/content/docs/docs/plugins/auto/getting-started.mdx
  • apps/docs/src/content/docs/docs/plugins/auto/index.mdx
  • apps/docs/src/content/docs/docs/plugins/auto/ios.mdx
  • apps/web/src/config/plugins.ts
  • apps/web/src/content/plugins-tutorials/en/capacitor-auto.md
  • apps/web/src/data/github-stars.json
  • apps/web/src/data/github-stats.json
  • apps/web/src/data/npm-downloads.json

Comment thread apps/docs/src/content/docs/docs/plugins/auto/index.mdx
@riderx riderx merged commit 38c8347 into main May 21, 2026
9 checks passed
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