chore(KNO-12023): documenting support for throttling with useGuides - #1348
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
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
.mdxcontent 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
Sent by Cursor Automation: Docs PR classifier
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.


Updates the guides documentation to reflect the new default throttling behavior for
useGuidesstarting in@knocklabs/reactv0.10.0.useGuidesnow respects throttling by default. Previously,useGuidesignored throttling rules and returned all eligible guides. Starting in v0.10.0, it respects throttling similar touseGuide.includeThrottledoption. 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 behaviortypedocs/react-core/hooks/use-guides.mdx- Added documentation for the newoptionsparameter andincludeThrottledoption, plus a new code example