Skip to content

[codex] add capacitor-proximity to docs and landing#571

Merged
riderx merged 2 commits intomainfrom
codex/add-proximity-plugin-docs
Apr 15, 2026
Merged

[codex] add capacitor-proximity to docs and landing#571
riderx merged 2 commits intomainfrom
codex/add-proximity-plugin-docs

Conversation

@riderx
Copy link
Copy Markdown
Member

@riderx riderx commented Apr 15, 2026

What changed

  • add @capgo/capacitor-proximity to the website plugin registry and sidebar/search config
  • add a dedicated proximity docs section, tutorial page, and docs icon

Why

  • expose the new Capgo proximity plugin on the landing site and docs so the GitHub homepage can point to a live docs URL

Validation

  • no local build or fetch steps run for this PR by request

Summary by CodeRabbit

  • New Features

    • Added Proximity plugin to the site and plugin listings, including navigation entry and action/icon support.
  • Documentation

    • Added Proximity plugin landing page and Getting Started guide with installation, platform behavior (iOS/Android/Web), API reference (enable/disable/getStatus/getPluginVersion), examples, best practices, and use cases.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 15, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2b6f1830-8802-4fd2-8614-6f7353041f15

📥 Commits

Reviewing files that changed from the base of the PR and between f9c01a8 and 4076739.

📒 Files selected for processing (1)
  • apps/docs/src/content/docs/docs/plugins/proximity/index.mdx
✅ Files skipped from review due to trivial changes (1)
  • apps/docs/src/content/docs/docs/plugins/proximity/index.mdx

📝 Walkthrough

Walkthrough

Added documentation and site configuration for the @capgo/capacitor-proximity Capacitor plugin: docs pages, tutorial, sidebar and registry entries, and web plugin metadata/icon mapping.

Changes

Cohort / File(s) Summary
Docs config & registries
apps/docs/src/config/llmsCustomSets.ts, apps/docs/src/config/sidebar.mjs, apps/web/src/config/plugins.ts
Added Plugin Proximity/@capgo/capacitor-proximity entries to LLM custom sets, sidebar plugin list, and web plugin registry (with icon mapping).
Docs site content
apps/docs/src/content/docs/docs/plugins/proximity/index.mdx, apps/docs/src/content/docs/docs/plugins/proximity/getting-started.mdx
Added plugin landing page and a detailed getting-started guide covering install, platform behavior (iOS/Android supported, Web unavailable), API, examples, and best practices.
Web tutorials
apps/web/src/content/plugins-tutorials/en/capacitor-proximity.md
Added tutorial with installation steps, TypeScript usage examples (including a ProximityService pattern), API summary, platform notes, and best-practice guidance.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 I sniff the docs and give a twitch,
A proximity plugin finds its niche,
Cards and guides hop into view,
iOS and Android say "we're true",
Hooray—tiny sensors, big new stitch! 🥕

🚥 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 '[codex] add capacitor-proximity to docs and landing' accurately describes the main change: adding the capacitor-proximity plugin to documentation and the landing site.
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-proximity-plugin-docs

Warning

Review ran into problems

🔥 Problems

Timed out fetching pipeline failures after 30000ms


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

@riderx riderx marked this pull request as ready for review April 15, 2026 09:53
@riderx
Copy link
Copy Markdown
Member Author

riderx commented Apr 15, 2026

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 15, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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 `@apps/docs/src/content/docs/docs/plugins/proximity/index.mdx`:
- Line 13: Replace the incorrect public asset path
"~public/icons/plugins/proximity.svg" in the frontmatter of index.mdx with a
root-relative path that starts with a single slash; locate the frontmatter entry
referencing "~public/icons/plugins/proximity.svg" and change it to
"/icons/plugins/proximity.svg" so Astro serves the asset from the public
directory correctly.
🪄 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: a204d215-9820-441a-9615-f4779136e4a5

📥 Commits

Reviewing files that changed from the base of the PR and between 371393a and f9c01a8.

⛔ Files ignored due to path filters (1)
  • apps/docs/public/icons/plugins/proximity.svg is excluded by !**/*.svg
📒 Files selected for processing (6)
  • apps/docs/src/config/llmsCustomSets.ts
  • apps/docs/src/config/sidebar.mjs
  • apps/docs/src/content/docs/docs/plugins/proximity/getting-started.mdx
  • apps/docs/src/content/docs/docs/plugins/proximity/index.mdx
  • apps/web/src/config/plugins.ts
  • apps/web/src/content/plugins-tutorials/en/capacitor-proximity.md

Comment thread apps/docs/src/content/docs/docs/plugins/proximity/index.mdx Outdated
@sonarqubecloud
Copy link
Copy Markdown

@riderx riderx merged commit 602b256 into main Apr 15, 2026
6 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