Skip to content

docs: add Contentsquare plugin docs#543

Open
riderx wants to merge 4 commits intomainfrom
codex/contentsquare-website
Open

docs: add Contentsquare plugin docs#543
riderx wants to merge 4 commits intomainfrom
codex/contentsquare-website

Conversation

@riderx
Copy link
Copy Markdown
Member

@riderx riderx commented Mar 25, 2026

Summary

  • add Contentsquare to the plugin index and docs navigation
  • add dedicated docs pages for overview, getting started, iOS setup, and Android notes
  • add the plugin tutorial entry and icon asset

Validation

  • attempted bun run build in the website worktree, but Astro stalled after startup warnings under Bun in this repo
  • attempted bunx --bun astro check, but it stalled at the same point
  • manually reviewed the new docs pages and config wiring after the build stall

Related

Summary by CodeRabbit

  • New Features

    • Added a Contentsquare plugin entry to the integrations directory and sidebar for easier discovery and access.
  • Documentation

    • Added comprehensive Contentsquare docs and tutorial: overview, getting started, iOS and Android setup, API usage (consent, screen/transaction/dynamic vars), session replay configuration, installation/validation guidance, and integration best practices.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 25, 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: d9e9a09d-4ae5-4a8e-a0fc-badc7fe37bfe

📥 Commits

Reviewing files that changed from the base of the PR and between a22057e and 9e783ce.

📒 Files selected for processing (3)
  • src/content/docs/docs/plugins/contentsquare/getting-started.mdx
  • src/content/docs/docs/plugins/contentsquare/index.mdx
  • src/content/plugins-tutorials/en/capacitor-contentsquare.md
✅ Files skipped from review due to trivial changes (3)
  • src/content/docs/docs/plugins/contentsquare/index.mdx
  • src/content/plugins-tutorials/en/capacitor-contentsquare.md
  • src/content/docs/docs/plugins/contentsquare/getting-started.mdx

📝 Walkthrough

Walkthrough

Adds Contentsquare Capacitor plugin registration and documentation: Starlight config and sidebar entries, plugin metadata in the plugins registry, four new MDX docs (overview, getting-started, iOS, Android), a docs index LinkCard, and an English tutorial page.

Changes

Cohort / File(s) Summary
Configuration & Registry
astro.config.mjs, src/config/plugins.ts
Added Starlight customSets and sidebar section for Contentsquare; inserted a new plugin entry (@capgo/capacitor-contentsquare) into the exported actions array with metadata (author, description, href, title, icon).
Plugin Documentation
src/content/docs/docs/plugins/contentsquare/index.mdx, src/content/docs/docs/plugins/contentsquare/getting-started.mdx, src/content/docs/docs/plugins/contentsquare/ios.mdx, src/content/docs/docs/plugins/contentsquare/android.mdx
Added four MDX pages: plugin overview with feature/frontmatter, Getting Started with installation and usage snippets (consent gating, screen/transaction/dyn-var flows, replay helpers), iOS setup for URL handling/deeplinks, and Android notes on WebView/API exposures and validation.
Site Integration & Tutorial
src/content/docs/docs/plugins/index.mdx, src/content/plugins-tutorials/en/capacitor-contentsquare.md
Added a LinkCard for Contentsquare in the plugins index and a full English tutorial describing install, consent handling, screen/transaction/dynamic-var usage, replay privacy checklist, and recommended integration patterns.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Poem

🐰 I hopped through docs and left a trail,
A Contentsquare patch with a crunchy detail,
Sidebar snug, the pages all set,
iOS, Android, guides you won't forget,
I bob my whiskers and nibble a carrot—cheer! 🥕✨

🚥 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 'docs: add Contentsquare plugin docs' accurately describes the main change, which is adding comprehensive documentation for the Contentsquare plugin across multiple files and sections.
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/contentsquare-website

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

@riderx
Copy link
Copy Markdown
Member Author

riderx commented Mar 26, 2026

Pushed a follow-up commit to reduce SonarCloud 'duplication on new code' by rewriting the Contentsquare tutorial to reference the canonical plugin docs instead of repeating the Getting Started content. Commit: a22057e.

@sonarqubecloud
Copy link
Copy Markdown

Quality Gate Failed Quality Gate failed

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

See analysis details on SonarQube Cloud

@riderx
Copy link
Copy Markdown
Member Author

riderx commented Mar 27, 2026

SonarCloud still fails on #543 with 100.0% Duplication on New Code after the template cleanup rewrite in src/content/docs/docs/plugins/contentsquare/index.mdx and src/content/docs/docs/plugins/contentsquare/getting-started.mdx. I reduced the obvious copied Starlight blocks, but the gate is still reporting duplicated new-code content, so this likely needs a deeper docs rewrite or the exact duplicated region from SonarCloud before it can pass.

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