feat: added kinde provider documentation #401
Conversation
WalkthroughThis update revises the React Native SDK documentation for improved clarity, formatting, and guidance. It introduces a new section detailing the Changes
Sequence Diagram(s)sequenceDiagram
participant App
participant useKindeProvider
participant KindeSDK
App->>useKindeProvider: Call hook on app initialization
useKindeProvider->>KindeSDK: Initialize and cache SDK instance
useKindeProvider->>KindeSDK: Manage session (validate/refresh token)
useKindeProvider-->>App: Return { isAuthenticated, verifyToken, authSdk }
App->>useKindeProvider: Use authentication state and SDK client
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
src/content/docs/developer-tools/sdks/native/react-native-sdk.mdx (5)
49-51: Refine conversational tone
Consider a more formal phrasing for consistency with technical documentation.- If you haven't already got a Kinde account, [register for free here](https://app.kinde.com/register) (no credit card required). Registering gives you a Kinde domain, which you need to get started, e.g. `yourapp.kinde.com`. + If you don't have a Kinde account, [register for free here](https://app.kinde.com/register) (no credit card required). Registering gives you a Kinde domain, which you need to get started, e.g. `yourapp.kinde.com`.
210-210: Fix duplicated word
The phrase repeats "local" twice.- Note: The `myapp://myhost.kinde.com/kinde_callback` is used as an example of local local URL Scheme, change to the local local URL Scheme that you use. + Note: The `myapp://myhost.kinde.com/kinde_callback` is used as an example of a URL scheme for your app; replace it with your own URL scheme.🧰 Tools
🪛 LanguageTool
[duplication] ~210-~210: Possible typo: you repeated a word.
Context: ...mple of local URL Scheme, change to the local local URL Scheme that you use. ## Environmen...(ENGLISH_WORD_REPEAT_RULE)
222-225: Correct verb usage
Use "call back" (verb) instead of "callback" (noun) and consider slight rewording for clarity.- `KINDE_POST_CALLBACK_URL` - After the user authenticates we will callback to this address. Make sure this URL is under your allowed callback URLs + `KINDE_POST_CALLBACK_URL` - After the user authenticates, we will call back to this address. Ensure this URL is listed in your allowed callback URLs.🧰 Tools
🪛 LanguageTool
[grammar] ~223-~223: The word “callback” is a noun. The verb is spelled with a space.
Context: ... - After the user authenticates we will callback to this address. Make sure this URL is ...(NOUN_VERB_CONFUSION)
1004-1006: Remove stray Markdown formatting
The_**//**_markup appears unintended and can be cleaned up.- await kinde.createOrg({org_name: 'your organization name'}); _**//**_ + await kinde.createOrg({org_name: 'your organization name'}); // Optionally specify your organization name
1229-1230: Fix article usage
Use "an" before "integer" for grammatical correctness.- Get a integer flag from the `feature_flags` claim of the access_token. + Get an integer flag from the `feature_flags` claim of the access_token.🧰 Tools
🪛 LanguageTool
[misspelling] ~1230-~1230: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...black###getIntegerFlagGet a integer flag from thefeature_flagsc...(EN_A_VS_AN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/content/docs/developer-tools/sdks/native/react-native-sdk.mdx(27 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/developer-tools/sdks/native/react-native-sdk.mdx
[duplication] ~210-~210: Possible typo: you repeated a word.
Context: ...mple of local URL Scheme, change to the local local URL Scheme that you use. ## Environmen...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~223-~223: The word “callback” is a noun. The verb is spelled with a space.
Context: ... - After the user authenticates we will callback to this address. Make sure this URL is ...
(NOUN_VERB_CONFUSION)
[misspelling] ~1230-~1230: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... black ### getIntegerFlag Get a integer flag from the feature_flags c...
(EN_A_VS_AN)
🔇 Additional comments (14)
src/content/docs/developer-tools/sdks/native/react-native-sdk.mdx (14)
77-77: Confirm consistency in step numbering
The Android build.gradle step aligns with the existing style.
96-96: Confirm consistency in step numbering
The MainApplication.java step follows the same pattern and is clear.
150-169: Approve Ruby & Bundler setup instructions
The new "Shell setup" section clearly guides users through installing Bundler and running CocoaPods via Bundler.
183-188: Approve Podfile update instructions
The added snippet for integrating RNKeychain and RNInAppBrowser via CocoaPods is clear and accurate.
191-194: Approve manual Xcode linking instructions
The bulleted steps for manually linking packages in Xcode are concise and complete.
201-203: Approve Kinde configuration steps
The numbered list for navigating to Settings > Applications is clear and properly formatted.
205-206: Approve callback URLs bullets
The examples for allowed callback and logout redirect URLs are correctly formatted.
318-320: Approve KindeProvider section header
The new section title clearly introduces the KindeProvider feature for React Native 0.7x.
322-326: Approve import usage example
The code snippet importinguseKindeProvideris concise and correct.
328-330: Approve hook description
The explanation of whatuseKindeProviderdoes is clear and well-placed.
333-339: Approve usage example
The TypeScript example demonstrates proper hook usage with required parameters.
341-345: Approve return values list
The list of returned values from the hook is accurate and formatted consistently.
347-351: Approve benefits list
The bulleted list effectively highlights the advantages of using KindeProvider.
369-369: Approve note about SDK initialization
The reminder to defineKindeSDKas a client variable is helpful and well-placed.
Description (required)
Added documentation detailing the use of the Kinde Provider
Related issues & labels (optional)
Summary by CodeRabbit