Skip to content

docs: add file sharer plugin#640

Merged
riderx merged 1 commit into
mainfrom
codex/add-file-sharer-plugin
May 6, 2026
Merged

docs: add file sharer plugin#640
riderx merged 1 commit into
mainfrom
codex/add-file-sharer-plugin

Conversation

@riderx
Copy link
Copy Markdown
Member

@riderx riderx commented May 6, 2026

Summary\n- add @capgo/capacitor-file-sharer to the website plugin registry\n- add docs, getting started page, and English tutorial\n- refresh plugin stars/download metadata for the new package\n\n## Test\n- NODE_OPTIONS=--max-old-space-size=16384 bun run check\n- bunx prettier --check apps/web/src/config/plugins.ts apps/docs/src/config/sidebar.mjs apps/docs/src/config/llmsCustomSets.ts apps/docs/src/content/docs/docs/plugins/file-sharer/index.mdx apps/docs/src/content/docs/docs/plugins/file-sharer/getting-started.mdx apps/web/src/content/plugins-tutorials/en/capacitor-file-sharer.md apps/web/src/data/github-stars.json apps/web/src/data/npm-downloads.json

Summary by CodeRabbit

  • New Features

    • Added File Sharer plugin for sharing and saving base64 data and local file paths.
  • Documentation

    • Added comprehensive getting started guide for the File Sharer plugin, including installation instructions, usage examples, and API reference.
    • Added plugin overview documentation detailing core capabilities and platform-specific behavior across Android, iOS, and Web.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 6, 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: 64b53b5e-f45a-4154-a4cb-d2148090935f

📥 Commits

Reviewing files that changed from the base of the PR and between 0701470 and 2d8409b.

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

📝 Walkthrough

Walkthrough

This pull request adds comprehensive documentation and configuration for the "@capgo/capacitor-file-sharer" plugin across the documentation and web applications. Configuration entries are registered, navigation items are added, and detailed guides covering installation, usage examples, type references, and platform-specific behavior are introduced.

Changes

File Sharer Plugin Documentation & Configuration

Layer / File(s) Summary
Plugin Registration & Metadata
apps/docs/src/config/llmsCustomSets.ts, apps/web/src/config/plugins.ts, apps/web/src/data/github-stars.json, apps/web/src/data/npm-downloads.json
Plugin "@capgo/capacitor-file-sharer" is registered with LLM custom sets, icon mapping ("Share"), and tracking entries for GitHub stars and npm downloads.
Navigation & Sidebar Integration
apps/docs/src/config/sidebar.mjs
"File Sharer" plugin entry is added to the plugin navigation array in sequential order.
Core Documentation
apps/docs/src/content/docs/docs/plugins/file-sharer/index.mdx
Main plugin documentation page with overview, core capabilities (share, save, getPluginVersion), platform behavior matrix, public API table, and source-of-truth reference.
Getting Started Guide
apps/docs/src/content/docs/docs/plugins/file-sharer/getting-started.mdx
Comprehensive installation, import, and usage examples for base64 files, local files, file saving, and text sharing; type references for ShareFileOptions, AndroidFileSharerOptions, SaveFileResult; error codes documentation.
Web Tutorial Documentation
apps/web/src/content/plugins-tutorials/en/capacitor-file-sharer.md
Tutorial covering installation, exposed APIs, usage examples (generated/local files, Android downloads), platform-specific notes, and reference links.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Poem

🐰 A sharer so fine, with documents new,
Files split and saved, both base64 and true,
Through Android and iOS, across every way,
The plugin takes flight—hip hip hooray! 📁✨

🚥 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 'docs: add file sharer plugin' accurately and concisely summarizes the main change: adding documentation and registry entries for the file-sharer plugin.
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.

✨ 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/add-file-sharer-plugin

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

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 6, 2026

@riderx riderx marked this pull request as ready for review May 6, 2026 07:34
@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.

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