Skip to content

docs: add RudderStack plugin website pages#545

Merged
riderx merged 2 commits intomainfrom
codex/rudderstack-website-docs
Mar 26, 2026
Merged

docs: add RudderStack plugin website pages#545
riderx merged 2 commits intomainfrom
codex/rudderstack-website-docs

Conversation

@riderx
Copy link
Copy Markdown
Member

@riderx riderx commented Mar 26, 2026

Summary

  • add RudderStack to the plugin registry and docs index
  • add the RudderStack overview and getting-started docs pages
  • add the plugin tutorial page, sidebar wiring, pagefind bucket, and icon asset

Validation

  • git diff --cached --check
  • attempted bun run astro -- check, but the command did not terminate in the current local website environment after Astro startup warnings

Summary by CodeRabbit

  • New Features

    • Added RudderStack analytics plugin for Capacitor with identity, screen tracking, and delivery/control features.
  • Documentation

    • Added comprehensive RudderStack docs: overview page, Getting Started guide, tutorial, and a featured plugins listing entry.
    • Added a collapsed sidebar section linking to the RudderStack overview and Getting Started pages.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 26, 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: 8c47bc9f-518a-4419-a1f1-d2fb4ff8a2b0

📥 Commits

Reviewing files that changed from the base of the PR and between f787aeb and 05c5b84.

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

📝 Walkthrough

Walkthrough

The PR adds site configuration and documentation for the RudderStack Capacitor plugin: a Starlight docs set and sidebar, a plugin registry entry, a featured card on the plugins index, an overview MDX page, a getting-started MDX, and an English tutorial.

Changes

Cohort / File(s) Summary
Site config / Registry
astro.config.mjs, src/config/plugins.ts
Added a Starlight docs set and sidebar section for "RudderStack" in astro.config.mjs; appended a new plugin entry for @capgo/capacitor-rudderstack to the exported actions array.
Plugins index
src/content/docs/docs/plugins/index.mdx
Added a new LinkCard for RudderStack linking to /docs/plugins/rudderstack/.
Plugin docs (overview + guide)
src/content/docs/docs/plugins/rudderstack/index.mdx, src/content/docs/docs/plugins/rudderstack/getting-started.mdx
Added an overview MDX with feature cards and a detailed getting-started MDX documenting installation, initialization, core APIs (identify, track, screen), per-call options, operational methods, and platform notes.
Tutorial
src/content/plugins-tutorials/en/capacitor-rudderstack.md
Added a new tutorial describing installation (package manager + cap sync), migration notes, example flows, platform behavior, and links to the repo/getting-started guide.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Poem

🐰 A tiny rabbit hops to write,
Docs and plugins snug and bright,
RudderStack sails, the pages bloom,
Guides and cards now fill the room,
Hooray — analytics take 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 clearly and accurately summarizes the main change: adding documentation pages for the RudderStack plugin to the website.
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/rudderstack-website-docs

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

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 `@src/content/docs/docs/plugins/rudderstack/index.mdx`:
- Around line 11-20: The hero metadata needs clearer phrasing and consistent
GitHub casing: update the tagline value (the line starting with "tagline:") to
read something like "Use a Cordova-compatible RudderStack API in Capacitor to
initialize, identify, group, track, screen, alias, and control delivery flows."
and change the actions array entry with text "Github" to "GitHub" (the entry
under actions -> - text: "Github") so the copy is more natural and uses correct
branding.
🪄 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: 8937793b-d4ab-40dc-a65e-7aac90a50fd1

📥 Commits

Reviewing files that changed from the base of the PR and between c6401e5 and f787aeb.

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

@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 riderx merged commit aaaa4c0 into main Mar 26, 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