feat: add passkey plugin docs by riderx · Pull Request #564 · Cap-go/website

riderx · 2026-04-14T10:32:02Z

Summary

add the passkey plugin to the public plugin registry
add the website tutorial for browser-style passkey setup
add docs pages for getting started, iOS, Android, and backend notes

Testing

bun run fmt
bun run build

Summary by CodeRabbit

Documentation
- Added comprehensive Passkey plugin docs: Getting Started, iOS setup, Android setup, backend notes, and a tutorial explaining installation, configuration, sync behavior, and platform caveats.
New Features
- Passkey plugin added to the docs sidebar and plugin catalog with a dedicated listing and icon for discovery.
Chores
- Added Passkey entries to site metadata (plugin listing, package/stars/downloads datasets) for visibility.

coderabbitai · 2026-04-14T10:32:10Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8decdd0c-6b6d-45f3-9964-19527f7b4aa6

📥 Commits

Reviewing files that changed from the base of the PR and between 30b5277 and 5b98d46.

📒 Files selected for processing (3)

apps/docs/src/config/llmsCustomSets.ts
apps/web/src/data/github-stars.json
apps/web/src/data/npm-downloads.json

✅ Files skipped from review due to trivial changes (3)

apps/web/src/data/npm-downloads.json
apps/docs/src/config/llmsCustomSets.ts
apps/web/src/data/github-stars.json

📝 Walkthrough

Walkthrough

Adds comprehensive docs and site registrations for the new @capgo/capacitor-passkey plugin: overview, platform guides (iOS/Android), backend notes, getting-started, web tutorial, sidebar entry, web plugin registry entry, LLMS set row, and small data updates for GitHub/npm mappings.

Changes

Cohort / File(s)	Summary
Docs Sidebar `apps/docs/src/config/sidebar.mjs`	Inserted a `pluginEntries` entry for the Passkey plugin with slug `passkey` and links to iOS, Android, and backend docs.
Web Plugin Registry & Data `apps/web/src/config/plugins.ts`, `apps/web/src/data/github-stars.json`, `apps/web/src/data/npm-downloads.json`	Registered `@capgo/capacitor-passkey` in the action definitions and icon map; added GitHub stars and npm downloads entries for the plugin.
Passkey Documentation Pages `apps/docs/src/content/docs/docs/plugins/passkey/index.mdx`, `.../getting-started.mdx`, `.../ios.mdx`, `.../android.mdx`, `.../backend.mdx`	Added overview, getting-started, iOS/Android platform setup details (entitlements/asset links), backend contract notes, and cap sync/host-file guidance.
Web Tutorial `apps/web/src/content/plugins-tutorials/en/capacitor-passkey.md`	Added tutorial describing install, config (`origin`/`autoShim`/`domains`), cap sync behavior, shim import, WebAuthn usage examples, and platform caveats.
LLMS Custom Sets `apps/docs/src/config/llmsCustomSets.ts`	Appended a "Plugin Passkey" row to the `llmsCustomSetRows` dataset pointing to `docs/plugins/passkey/**`.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

[codex] sync plugin registry and docs #552: Adds plugin docs/registry integration; likely related to introducing the plugin-docs/sidebar pattern used here.

Poem

🐰 I found a tiny key and hopped to write,

iOS, Android, backend — all lined up bright.
Sync tunes hosts and origins sing,
Docs laid out for every spring.
A cheerful rabbit nudges: merrily secure and light!

🚥 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 describes the main changeset: adding comprehensive documentation for the passkey plugin across multiple docs files, sidebar configuration, and plugin registry.
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 docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch codex/passkey-website-docs

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

coderabbitai

Actionable comments posted: 2

🤖 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/passkey/index.mdx`:
- Line 17: Update the CTA label that currently reads "text: Github" to use the
official capitalization "text: GitHub" so the CTA uses correct branding; locate
the CTA definition (the line containing "text: Github") and replace the value
with "GitHub".

In `@apps/web/src/content/plugins-tutorials/en/capacitor-passkey.md`:
- Line 14: Replace the phrase "returns browser-like credential objects back to
your app" with "returns browser-like credential objects to your app" in the
sentence that describes the native shim behavior for
navigator.credentials.create() and navigator.credentials.get(), so the line now
reads that the plugin forwards requests to iOS/Android passkey APIs and returns
browser-like credential objects to your app.

🪄 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: 304eb902-eb83-4aaa-af8b-ab1f59218253

📥 Commits

Reviewing files that changed from the base of the PR and between 7d028e0 and 4adf15b.

📒 Files selected for processing (8)

apps/docs/src/config/sidebar.mjs
apps/docs/src/content/docs/docs/plugins/passkey/android.mdx
apps/docs/src/content/docs/docs/plugins/passkey/backend.mdx
apps/docs/src/content/docs/docs/plugins/passkey/getting-started.mdx
apps/docs/src/content/docs/docs/plugins/passkey/index.mdx
apps/docs/src/content/docs/docs/plugins/passkey/ios.mdx
apps/web/src/config/plugins.ts
apps/web/src/content/plugins-tutorials/en/capacitor-passkey.md

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 4adf15b759

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

sonarqubecloud · 2026-04-14T11:00:42Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

feat: add passkey plugin docs

4adf15b

riderx marked this pull request as ready for review April 14, 2026 10:32

coderabbitai bot reviewed Apr 14, 2026

View reviewed changes

Comment thread apps/docs/src/content/docs/docs/plugins/passkey/index.mdx Outdated

Comment thread apps/web/src/content/plugins-tutorials/en/capacitor-passkey.md Outdated

chatgpt-codex-connector bot reviewed Apr 14, 2026

View reviewed changes

Comment thread apps/docs/src/config/sidebar.mjs

Comment thread apps/web/src/config/plugins.ts

riderx added 2 commits April 14, 2026 12:45

docs: fix passkey review nits

30b5277

docs: register passkey search metadata

5b98d46

riderx merged commit 0cbcc1c into main Apr 14, 2026
6 checks passed

This was referenced Apr 14, 2026

[codex] restore Contentsquare plugin docs #568

Merged

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

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add passkey plugin docs#564

feat: add passkey plugin docs#564
riderx merged 3 commits intomainfrom
codex/passkey-website-docs

riderx commented Apr 14, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Apr 14, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

chatgpt-codex-connector bot left a comment

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Apr 14, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

riderx commented Apr 14, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Testing

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Apr 14, 2026

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

riderx commented Apr 14, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 14, 2026 •

edited

Loading