Docs content for the throttle step #979

Aviatorscode2 · 2025-09-26T12:10:32Z

Summary by CodeRabbit

Documentation
- Added a new “Throttle Step” workflow guide to Platform docs, now reachable from navigation.
- Explains how throttling limits workflow executions per subscriber using fixed and dynamic window modes.
- Details configuration: name/identifier, duration, execution thresholds, grouping by payload keys, and dynamic windows via timestamps or duration objects.
- Includes example scenarios (weekly limits, per-project throttling), cross-channel behavior notes, and visuals.

linear · 2025-09-26T12:10:34Z

netlify · 2025-09-26T12:10:37Z

❌ Deploy Preview for docs-novu failed. Why did it fail? →

Name	Link
🔨 Latest commit	`5559912`
🔍 Latest deploy log	https://app.netlify.com/projects/docs-novu/deploys/68d732d2f0636300089e139c

coderabbitai · 2025-09-26T12:10:40Z

Walkthrough

Adds a new Throttle Step documentation page and updates the platform docs navigation to include it. No code or behavior changes.

Changes

Cohort / File(s)	Summary
Docs navigation update `content/docs/platform/meta.json`	Added `"workflow/throttle-step"` to the `pages` array.
New Throttle Step doc `content/docs/platform/workflow/throttle-step.mdx`	Added documentation describing the Throttle Step: purpose, fixed and dynamic window modes, configuration fields (Name, Identifier, window settings, thresholds, grouping), examples, cross-channel notes, and visuals.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I’m a rabbit in the docs tonight,
Counting hops to keep them light.
Fixed or dynamic, windows set,
Throttle the bursts, no regret.
Hops paced neat — the docs delight. 🥕

Pre-merge checks and finishing touches

✅ 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 succinctly and accurately describes that this pull request adds documentation content for the throttle step in workflows, directly reflecting the addition of the new throttle-step page and the update to the site metadata.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch MRK-1066

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7a9de8d and 5559912.

📒 Files selected for processing (1)

content/docs/platform/workflow/throttle-step.mdx (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

content/docs/platform/workflow/throttle-step.mdx

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 79137d1 and 1e7127e.

⛔ Files ignored due to path filters (3)

public/images/workflows/dynamic-window.png is excluded by !**/*.png
public/images/workflows/fixed-window.png is excluded by !**/*.png
public/images/workflows/throttle-step-activity-feed.png is excluded by !**/*.png

📒 Files selected for processing (2)

content/docs/platform/meta.json (1 hunks)
content/docs/platform/workflow/throttle-step.mdx (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: Build and Lint

🔇 Additional comments (1)

content/docs/platform/meta.json (1)

31-31: Entry looks good

The throttle step page is now discoverable alongside the other workflow docs, consistent with the existing slug conventions.