Skip to content

chore(KNO-12023): documenting support for throttling with useGuides - #1348

Merged
scotidodson merged 3 commits into
mainfrom
sd-KNO-12023-includeThrottled
Mar 11, 2026
Merged

chore(KNO-12023): documenting support for throttling with useGuides#1348
scotidodson merged 3 commits into
mainfrom
sd-KNO-12023-includeThrottled

Conversation

@scotidodson

Copy link
Copy Markdown
Contributor

Updates the guides documentation to reflect the new default throttling behavior for useGuides starting in @knocklabs/react v0.10.0.

  • useGuides now respects throttling by default. Previously, useGuides ignored throttling rules and returned all eligible guides. Starting in v0.10.0, it respects throttling similar to useGuide.
  • New includeThrottled option. Users who need the previous behavior can pass { includeThrottled: true } to return all eligible guides regardless of throttling.

Files changed

  • content/in-app-ui/guides/render-guides.mdx - Updated two FAQ sections to reflect the new behavior
  • typedocs/react-core/hooks/use-guides.mdx - Added documentation for the new options parameter and includeThrottled option, plus a new code example

@linear

linear Bot commented Mar 11, 2026

Copy link
Copy Markdown

@vercel

vercel Bot commented Mar 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Mar 11, 2026 9:59pm

Request Review

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk LOW: Documents the new includeThrottled option for useGuides and updates FAQ sections to reflect default throttling behavior starting in @knocklabs/react v0.10.0.

Reasons

  • Only 2 .mdx content files are modified — no components, layouts, config, or code files touched
  • Small diff with 46 additions and 3 deletions (49 total lines), well under the 50-line threshold
  • No new pages added; both files are updates to existing documentation
  • No sidebar navigation or build configuration changes
  • Author (scotidodson) is a known repository contributor

Notes

  • The new code examples in both files use { includeThrottled: true } — reviewers may want to verify this matches the actual SDK API surface
  • The link to throttling rules is used consistently across the changes; worth confirming the anchor still resolves correctly after any recent changes to that page
Open in Web View Automation 

Sent by Cursor Automation: Docs PR classifier

@scotidodson scotidodson changed the title documenting support for throttling with useGuides chore(KNO-12023): documenting support for throttling with useGuides Mar 11, 2026
@scotidodson
scotidodson merged commit 90389a0 into main Mar 11, 2026
5 checks passed
@scotidodson
scotidodson deleted the sd-KNO-12023-includeThrottled branch March 11, 2026 22:01
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