feat: added kinde provider documentation#401
Conversation
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughDocumentation edits to the React Native SDK page: added iOS Bundler/CocoaPods setup steps, introduced the React Native 0.7x ChangesReact Native SDK docs
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
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![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.
|
This looks good and can be merged in @onderay |
|
@brettchaldecott, kindly create your PR directly to the main repo from now on, so that it will generate a preview with Cloudflare, and we can also directly open and edit it within our local machine and perform minor edits. Sincerely, |
|
@victoreronmosele what is the status of this PR? can you take a look at the merge conflicts? |
|
Hi @tamalchowdhury, sorry I missed this comment. I'll implement the fixes and resolve the merge conflicts. |
…o feat/react-native-v7/kinde-provider
|
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | |
|---|---|---|---|---|---|
| 21029323 | Triggered | Generic High Entropy Secret | 9543025 | scripts/generate-llms-txt-sections.js | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secret safely. Learn here the best practices.
- Revoke and rotate this secret.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
|
@tamalchowdhury I have implemented the relevant fixes and resolved the merge conflicts. |
4 participants
Description (required)
Added documentation detailing the use of the Kinde Provider
Related issues & labels (optional)
Summary by CodeRabbit