diff --git a/content/docs/dashboard/guides/superwall-skill.mdx b/content/docs/dashboard/guides/superwall-skill.mdx new file mode 100644 index 0000000..dbd8c13 --- /dev/null +++ b/content/docs/dashboard/guides/superwall-skill.mdx @@ -0,0 +1,113 @@ +--- +title: "Superwall Skill" +description: "Give AI coding agents up-to-date Superwall docs, API access, and step-by-step SDK integration guides using the Superwall Skill." +--- + +The [Superwall Skill](https://github.com/superwall/skills) is a set of [Agent Skills](https://agentskills.io) that give AI coding agents everything they need to work with Superwall. It has access to live documentation, API access, dashboard information, and guided SDK integration flows for every platform. + + +This is different from the [Superwall MCP](/dashboard/guides/superwall-mcp), which connects AI tools to your Superwall account to create and manage resources. The Superwall Skill can perform all of the tasks the MCP can, and is recommended. + + +## Installation + +Install with the [skills.sh](https://skills.sh) CLI. This works with any agent that supports skills, including Claude Code, Cursor, and Codex. + +Install all skills (recommended): + +```bash +npx skills add superwall/skills +``` + +Or install individual skills: + +```bash +# General skill (docs, API, dashboard links) +npx skills add superwall/skills --skill superwall + +# Platform-specific quickstart +npx skills add superwall/skills --skill superwall-ios-quickstart +npx skills add superwall/skills --skill superwall-android-quickstart +npx skills add superwall/skills --skill superwall-flutter-quickstart +npx skills add superwall/skills --skill superwall-expo-quickstart +``` + +## What's included + +The Superwall Skill is made up of a general-purpose skill and platform-specific quickstart skills. + +### General skill + +The `superwall` skill gives agents access to: + +- **Live documentation**: Agents fetch docs on demand from `llms.txt` and per-page markdown endpoints, so they always have the latest information. +- **API access**: A bundled `sw-api.sh` helper wraps the Superwall V2 API. Agents can list projects, inspect applications, and manage resources directly from the terminal. +- **Dashboard links**: URL patterns for every dashboard page, so agents can link you to the right place (settings, campaigns, paywalls, users, and more). +- **SDK source cloning**: Agents can clone SDK repos locally to trace internal behavior when debugging. +- **Webhook and integration catalog**: Fetched live from the Superwall integrations endpoint. + +### Platform quickstart skills + +Each quickstart skill walks the agent through a full SDK integration, step by step: + +| Skill | Platform | +|-------|----------| +| `superwall-ios-quickstart` | iOS (Swift / Objective-C) | +| `superwall-android-quickstart` | Android (Kotlin / Java) | +| `superwall-flutter-quickstart` | Flutter | +| `superwall-expo-quickstart` | Expo | + +Every quickstart follows the same flow: + +1. **Install**: Installs the SDK dependency. +2. **Configure**: Ensures Superwall is ready at app launch. +3. **User management**: Identify users on sign-in, reset on logout. +4. **Feature gating**: Register placements and present paywalls. +5. **Subscription tracking**: Observe subscription status changes. +6. **User properties**: Set custom attributes for audience targeting. +7. **Paywall previews**: Sset up deep links for on-device previews. + +The agent reads bundled reference docs for each step, inspects your project, and implements minimal, production-safe changes before moving on to the next step. + +## API access + +The general skill includes a bash helper (`sw-api.sh`) that wraps the Superwall REST API V2. It requires a `SUPERWALL_API_KEY` environment variable. That's an org-scoped bearer token you can generate from [API Keys settings](https://superwall.com/select-application?pathname=/applications/:app/settings/api-keys). + +```bash +# List all available API routes (no API key needed) +sw-api.sh --help + +# Show the full spec for a specific route +sw-api.sh --help /v2/projects + +# List all projects +sw-api.sh /v2/projects + +# Get a specific project +sw-api.sh /v2/projects/{id} + +# Create a project +sw-api.sh -m POST -d '{"name":"My Project"}' /v2/projects +``` + +The `--help` flag fetches the live OpenAPI spec, so the route reference is always current. + +### Data hierarchy + +Superwall organizes data as **Organization → Projects → Applications**. Each application has a `platform` (ios, android, flutter, react_native, web), a `bundle_id`, and a `public_api_key` used for SDK initialization. The org-scoped `SUPERWALL_API_KEY` is separate, it's used for API calls. + +## Quick start + +Ask your AI agent to integrate Superwall into your app. The agent will: + +1. Detect your platform from the project structure (e.g., `Package.swift` → iOS, `pubspec.yaml` → Flutter). +2. Determine your purchase controller path, whether you're using Superwall's default purchase handling, RevenueCat, or a custom setup. +3. Walk through the quickstart steps, implementing each one in your codebase. + +If you've installed the general skill with an API key, the agent can also look up your projects and applications to find the right `public_api_key` for SDK configuration. + +## Related + +- [Superwall MCP](/dashboard/guides/superwall-mcp): For managing your Superwall account from AI tools. +- [Superwall Docs MCP](/ios/guides/vibe-coding#superwall-docs-mcp): Give AI tools access to Superwall documentation. +- [Vibe Coding](/ios/guides/vibe-coding): Aall the AI tools available for working with Superwall listed in one place. diff --git a/content/docs/dashboard/meta.json b/content/docs/dashboard/meta.json index 1a3b785..30fe033 100644 --- a/content/docs/dashboard/meta.json +++ b/content/docs/dashboard/meta.json @@ -24,6 +24,7 @@ "manage-account", "---Guides---", + "guides/superwall-skill", "guides/superwall-mcp", "guides/using-stripe-checkout-in-app", "guides/migrating-from-revenuecat-to-superwall", diff --git a/content/shared/vibe-coding.mdx b/content/shared/vibe-coding.mdx index be7640b..da5888c 100644 --- a/content/shared/vibe-coding.mdx +++ b/content/shared/vibe-coding.mdx @@ -5,11 +5,12 @@ description: "How to Vibe Code using the knowledge of the Superwall Docs" ## Overview -We've built a few tools to help you Vibe Code using the knowledge of the Superwall Docs, right in your favorite AI tools: +We've built a few tools to help you Vibe Code using the knowledge of the Superwall Docs, access your Superwall account, and more right in your favorite AI tools: -- [Superwall Docs MCP](#superwall-docs-mcp) in Claude Code, Cursor, etc. -- [Superwall MCP](#superwall-mcp) — manage your Superwall account (projects, paywalls, campaigns) from AI tools -- [Superwall Docs GPT](#superwall-docs-gpt) in ChatGPT +- [Superwall Skill](/dashboard/guides/superwall-skill): Gives AI agents live docs, API access, and step-by-step SDK integration guides. If you're unsure which tool to use, pick this one. +- [Superwall Docs MCP](#superwall-docs-mcp): Give an agent Superwall documentation access in tools like Claude Code, Cursor, etc. +- [Superwall MCP](#superwall-mcp): Expose your Superwall account (projects, paywalls, campaigns) to work with AI tools. +- [Superwall Docs GPT](#superwall-docs-gpt): Docs for use in ChatGPT. And right here in the Superwall Docs: - [Ask AI](#ask-ai) @@ -18,6 +19,18 @@ And right here in the Superwall Docs: +## Superwall Skill (Recommended) + +The [Superwall Skill](/dashboard/guides/superwall-skill) is the best way to give AI coding agents full context on Superwall. It bundles live documentation, API access, dashboard links, and guided SDK integration flows for every platform, all in one install. If you're unsure which tool to use, pick this one. + +```bash +npx skills add superwall/skills +``` + +Once installed, your agent can look up any Superwall doc on demand, call the API to inspect your projects and applications, and walk through a complete SDK integration step by step. It supports iOS, Android, Flutter, and Expo out of the box with platform-specific quickstart skills. + +If you're only going to set up one tool, this is the one to use. See the full [Superwall Skill guide](/dashboard/guides/superwall-skill) for details. + ## Superwall Docs MCP The Superwall Docs MCP ([Model Context Protocol](https://modelcontextprotocol.io/docs/tutorials/use-remote-mcp-server)) is a tool that allows your favorite AI tools to search the Superwall Docs and get context from the docs. diff --git a/src/lib/changelog-entries.json b/src/lib/changelog-entries.json index 8cb0bc1..bc2f363 100644 --- a/src/lib/changelog-entries.json +++ b/src/lib/changelog-entries.json @@ -1,6 +1,131 @@ { - "lastUpdated": "2026-03-18T17:59:31.535Z", + "lastUpdated": "2026-03-27T19:51:33.078Z", "entries": [ + { + "key": "content/docs/flutter/changelog.mdx:73587ebb4a17fa4a70b74474dace5aea5b5d9b56", + "path": "flutter/changelog.mdx", + "title": "Changelog", + "description": "Updated Flutter SDK documentation", + "category": "Flutter SDK", + "url": "/docs/flutter/changelog", + "date": "2026-03-20T20:21:59.000Z", + "changeType": "modified" + }, + { + "key": "content/docs/flutter/index.mdx:73587ebb4a17fa4a70b74474dace5aea5b5d9b56", + "path": "flutter/index.mdx", + "title": "Welcome", + "description": "Updated Flutter SDK documentation", + "category": "Flutter SDK", + "url": "/docs/flutter", + "date": "2026-03-20T20:21:59.000Z", + "changeType": "modified" + }, + { + "key": "content/docs/flutter/sdk-reference/IntegrationAttribute.mdx:73587ebb4a17fa4a70b74474dace5aea5b5d9b56", + "path": "flutter/sdk-reference/IntegrationAttribute.mdx", + "title": "IntegrationAttribute", + "description": "Updated sdk reference for Flutter SDK", + "category": "Flutter SDK", + "subcategory": "SDK Reference", + "url": "/docs/flutter/sdk-reference/IntegrationAttribute", + "date": "2026-03-20T20:21:59.000Z", + "changeType": "modified" + }, + { + "key": "content/docs/flutter/sdk-reference/SuperwallOptions.mdx:73587ebb4a17fa4a70b74474dace5aea5b5d9b56", + "path": "flutter/sdk-reference/SuperwallOptions.mdx", + "title": "SuperwallOptions", + "description": "Updated sdk reference for Flutter SDK", + "category": "Flutter SDK", + "subcategory": "SDK Reference", + "url": "/docs/flutter/sdk-reference/SuperwallOptions", + "date": "2026-03-20T20:21:59.000Z", + "changeType": "modified" + }, + { + "key": "content/docs/flutter/sdk-reference/index.mdx:73587ebb4a17fa4a70b74474dace5aea5b5d9b56", + "path": "flutter/sdk-reference/index.mdx", + "title": "Overview", + "description": "Updated sdk reference for Flutter SDK", + "category": "Flutter SDK", + "subcategory": "SDK Reference", + "url": "/docs/flutter/sdk-reference", + "date": "2026-03-20T20:21:59.000Z", + "changeType": "modified" + }, + { + "key": "content/docs/dashboard/dashboard-creating-paywalls/paywall-editor-styling-elements.mdx:31a7365538fa6c506a0c0b2eaf067ae67ccd708f", + "path": "dashboard/dashboard-creating-paywalls/paywall-editor-styling-elements.mdx", + "title": "Styling Elements", + "description": "Updated creating paywalls for Dashboard", + "category": "Dashboard", + "subcategory": "Creating Paywalls", + "url": "/docs/dashboard/dashboard-creating-paywalls/paywall-editor-styling-elements", + "date": "2026-03-19T19:18:30.000Z", + "changeType": "modified" + }, + { + "key": "content/docs/dashboard/guides/using-stripe-checkout-in-app.mdx:31a7365538fa6c506a0c0b2eaf067ae67ccd708f", + "path": "dashboard/guides/using-stripe-checkout-in-app.mdx", + "title": "Using Stripe's New Web Checkout In-App", + "description": "Updated guides for Dashboard", + "category": "Dashboard", + "subcategory": "Guides", + "url": "/docs/dashboard/guides/using-stripe-checkout-in-app", + "date": "2026-03-19T19:18:30.000Z", + "changeType": "modified" + }, + { + "key": "content/docs/integrations/adjust.mdx:31a7365538fa6c506a0c0b2eaf067ae67ccd708f", + "path": "integrations/adjust.mdx", + "title": "Adjust", + "description": "New Integrations documentation", + "category": "Integrations", + "url": "/docs/integrations/adjust", + "date": "2026-03-19T19:18:30.000Z", + "changeType": "added" + }, + { + "key": "content/docs/integrations/appstack.mdx:31a7365538fa6c506a0c0b2eaf067ae67ccd708f", + "path": "integrations/appstack.mdx", + "title": "Appstack", + "description": "New Integrations documentation", + "category": "Integrations", + "url": "/docs/integrations/appstack", + "date": "2026-03-19T19:18:30.000Z", + "changeType": "added" + }, + { + "key": "content/docs/integrations/appstance.mdx:31a7365538fa6c506a0c0b2eaf067ae67ccd708f", + "path": "integrations/appstance.mdx", + "title": "AppStance", + "description": "New Integrations documentation", + "category": "Integrations", + "url": "/docs/integrations/appstance", + "date": "2026-03-19T19:18:30.000Z", + "changeType": "added" + }, + { + "key": "content/docs/integrations/posthog.mdx:31a7365538fa6c506a0c0b2eaf067ae67ccd708f", + "path": "integrations/posthog.mdx", + "title": "PostHog", + "description": "New Integrations documentation", + "category": "Integrations", + "url": "/docs/integrations/posthog", + "date": "2026-03-19T19:18:30.000Z", + "changeType": "added" + }, + { + "key": "content/docs/web-checkout/web-checkout-direct-stripe-checkout.mdx:31a7365538fa6c506a0c0b2eaf067ae67ccd708f", + "path": "web-checkout/web-checkout-direct-stripe-checkout.mdx", + "title": "App2Web", + "description": "Updated Web Checkout documentation", + "category": "Web Checkout", + "url": "/docs/web-checkout/web-checkout-direct-stripe-checkout", + "date": "2026-03-19T19:18:30.000Z", + "changeType": "modified" + }, { "key": "content/docs/dashboard/guides/using-stripe-checkout-in-app.mdx:c6dc2b47235153d0f6d276dccb1141655f638798", "path": "dashboard/guides/using-stripe-checkout-in-app.mdx",