add-channel-whats-next-onboarding

Adds a chat channel's connected-state onboarding guide and details page to the Novu dashboard.

39.7k|4.4k|Updated Aug 26, 2021
One-click install
npx skills add https://github.com/novuhq/novu --skill add-channel-whats-next-onboarding
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-channel-whats-next-onboarding
Source: https://github.com/novuhq/novu/tree/main/.cursor/skills/add-channel-whats-next-onboarding
Command: npx skills add https://github.com/novuhq/novu --skill add-channel-whats-next-onboarding

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

When a new chat provider (like Discord) is integrated into the Novu dashboard, developers must manually recreate the post-connection "What's next" rollout guide and connected details page, wiring configs, resolvers, and display names across multiple files while matching the existing Slack, MS Teams, and Telegram patterns.

Core Features & Use Cases

  • Data-driven guide config: Creates a build<Channel>WhatsNextConfig returning recap steps and developer rollout steps, including the @novu/react install step and <Channel>ConnectButton code snippet.
  • Connected details page: Generates a <Channel>AgentConnectedDetails component using the shared AgentConnectedDetailsShell with provider credential sections via render-props.
  • Registry wiring: Registers the builder in WHATS_NEXT_CONFIG_BUILDERS and adds resolver switch cases plus display-name entries.
  • Use Case: You added a Discord integration to Novu and need the dashboard to show developers how to roll it out to their end users after connecting — this Skill scaffolds the config, details view, and wiring following the Telegram template.

Quick Start

Add the layer-2 "What's next" onboarding and connected details page for the Discord chat channel following the existing Telegram pattern.

Frequently Asked Questions about add-channel-whats-next-onboarding

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a What's next onboarding guide for a new chat channel in the Novu dashboard?

Create a whats-next config file exporting build<Channel>WhatsNextConfig, create a <Channel>AgentConnectedDetails component using AgentConnectedDetailsShell, then register the builder in whats-next-config.ts and add cases to the resolver and display-name switches.

What is the difference between layer-1 and layer-2 channel onboarding in Novu?

Layer 1 is the setup guide that connects the channel itself (<channel>-setup-guide.tsx). Layer 2 is the post-connection "What's next" guide that helps developers roll the agent out to their end users with @novu/react and a ConnectButton snippet.

What prerequisites are needed before adding a channel's connected onboarding guide?

The channel needs a ChatProviderIdEnum entry in @novu/shared, an existing layer-1 setup guide file, and a <Channel>ConnectButton component in @novu/react. Without these, the layer-2 guide cannot render its dev steps.

Does the What's next guide require a dedicated feature flag?

No. By default it rides the umbrella IS_AGENT_WHATS_NEXT_ENABLED flag. A per-provider flag like IS_AGENT_<CHANNEL>_WHATS_NEXT_ENABLED is only needed for independent rollout, as MS Teams does.

Which existing channel should I copy when adding a new What's next config?

Copy Telegram for the simplest bot/deep-link pattern, Slack for workspace install plus a distribution link built from credentials, or MS Teams for org-wide distribution with its own feature flag.