Skip to content

Add privacy screen plugin to landing#525

Merged
riderx merged 1 commit intomainfrom
codex/privacy-screen-landing
Mar 17, 2026
Merged

Add privacy screen plugin to landing#525
riderx merged 1 commit intomainfrom
codex/privacy-screen-landing

Conversation

@riderx
Copy link
Copy Markdown
Member

@riderx riderx commented Mar 17, 2026

Summary

  • add the privacy screen plugin to the landing plugin registry and docs index
  • add dedicated docs pages for overview, getting started, iOS behavior, and Android behavior
  • add the tutorial page and plugin icon asset for the new docs route

Testing

  • not run (per request)

Summary by CodeRabbit

Release Notes

  • New Features

    • Added Privacy Screen plugin to the plugin catalog for protecting app content.
  • Documentation

    • Added Getting Started guide with installation and usage instructions.
    • Added platform-specific behavior documentation for iOS and Android.
    • Added comprehensive tutorial for plugin implementation.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 17, 2026

📝 Walkthrough

Walkthrough

Introduces comprehensive support for the @capgo/capacitor-privacy-screen plugin across documentation, configuration, and navigation. Adds plugin registration, sidebar navigation entries, feature overview page, platform-specific behavior documentation, getting-started guide, and tutorial content.

Changes

Cohort / File(s) Summary
Plugin Configuration
astro.config.mjs, src/config/plugins.ts
Registers new Privacy Screen plugin with author, description, and icon; adds navigation structure with Privacy Screen sidebar group containing Overview, Getting started, iOS behavior, and Android behavior subsections.
Plugin Documentation Index
src/content/docs/docs/plugins/index.mdx
Adds two LinkCard entries for Privacy Screen plugin under utility plugins and Capgo Cloud Updater sections, linking to plugin overview page.
Privacy Screen Plugin Docs
src/content/docs/docs/plugins/privacy-screen/index.mdx, getting-started.mdx, android.mdx, ios.mdx
Introduces comprehensive plugin documentation: overview with feature highlights, getting-started with installation and usage instructions, Android-specific details on FLAG_SECURE protection, iOS-specific overlay behavior and app switcher snapshot handling.
Tutorial Documentation
src/content/plugins-tutorials/en/capacitor-privacy-screen.md
Adds tutorial documenting plugin functionality, installation steps, basic usage with enable/disable/isEnabled APIs, and platform-specific behavior notes for iOS and Android.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Poem

🐰 A privacy screen blooms in the garden so bright,
Screenshots and switchers now hidden from sight,
With docs and with guides, all arranged just right,
The plugin takes flight! ✨

🚥 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 'Add privacy screen plugin to landing' directly and accurately summarizes the main change: adding a new privacy screen plugin to the landing page, plugin registry, and documentation.
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 (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/privacy-screen-landing
📝 Coding Plan
  • Generate coding plan for human review comments

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

@sonarqubecloud
Copy link
Copy Markdown

Quality Gate Failed Quality Gate failed

Failed conditions
65.2% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

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.

🧹 Nitpick comments (1)
src/content/docs/docs/plugins/privacy-screen/getting-started.mdx (1)

27-29: Consider varying sentence structure for readability.

Three consecutive sentences begin with "On" (Android, iOS, Web). This is a minor stylistic issue flagged by static analysis.

✏️ Suggested revision
-- On Android, secure mode blocks screenshots, screen recording capture, and the recent apps preview.
-- On iOS, the plugin hides your app during app switcher snapshot generation.
-- On Web, the plugin keeps an in-memory enabled flag only for API parity.
+- **Android:** Secure mode blocks screenshots, screen recording capture, and the recent apps preview.
+- **iOS:** The plugin hides your app during app switcher snapshot generation.
+- **Web:** The plugin keeps an in-memory enabled flag only for API parity.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/content/docs/docs/plugins/privacy-screen/getting-started.mdx` around
lines 27 - 29, Rewrite the three sentences that currently start with "On"
(referencing Android, iOS, Web) to vary sentence openings for readability; e.g.,
start one with "Secure mode on Android..." or "Android devices block
screenshots...", another with "iOS hides your app..." or "During app switching,
iOS..." and the third with "For web, the plugin..." or "On the Web platform, the
plugin..."; update the lines mentioning Android, iOS, and Web in the
getting-started section so each sentence uses a different leading phrase while
preserving the original meanings about screenshots/recording/recent-apps, app
switcher snapshot hiding, and in-memory flag for API parity.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@src/content/docs/docs/plugins/privacy-screen/getting-started.mdx`:
- Around line 27-29: Rewrite the three sentences that currently start with "On"
(referencing Android, iOS, Web) to vary sentence openings for readability; e.g.,
start one with "Secure mode on Android..." or "Android devices block
screenshots...", another with "iOS hides your app..." or "During app switching,
iOS..." and the third with "For web, the plugin..." or "On the Web platform, the
plugin..."; update the lines mentioning Android, iOS, and Web in the
getting-started section so each sentence uses a different leading phrase while
preserving the original meanings about screenshots/recording/recent-apps, app
switcher snapshot hiding, and in-memory flag for API parity.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5f0ac08f-efd6-474f-95d1-8cfad4027b23

📥 Commits

Reviewing files that changed from the base of the PR and between 05fb96c and 6b58ebe.

⛔ Files ignored due to path filters (1)
  • public/icons/plugins/privacy-screen.svg is excluded by !**/*.svg
📒 Files selected for processing (8)
  • astro.config.mjs
  • src/config/plugins.ts
  • src/content/docs/docs/plugins/index.mdx
  • src/content/docs/docs/plugins/privacy-screen/android.mdx
  • src/content/docs/docs/plugins/privacy-screen/getting-started.mdx
  • src/content/docs/docs/plugins/privacy-screen/index.mdx
  • src/content/docs/docs/plugins/privacy-screen/ios.mdx
  • src/content/plugins-tutorials/en/capacitor-privacy-screen.md

@riderx riderx merged commit d20d95c into main Mar 17, 2026
5 of 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