Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ios-sdk.mdx #299

Merged
merged 3 commits into from
Dec 23, 2024

Conversation

wahabniazi56
Copy link
Contributor

@wahabniazi56 wahabniazi56 commented Dec 17, 2024

Description (required)

Related issues & labels (optional)

  • Closes #
  • Suggested label:

Summary by CodeRabbit

  • New Features

    • Added a new section on implementing a custom logging mechanism in the Kinde iOS SDK documentation.
  • Documentation

    • Updated the method call for configuring the Kinde SDK to simplify syntax.

Copy link
Contributor

coderabbitai bot commented Dec 17, 2024

Walkthrough

The pull request introduces documentation updates for the Kinde iOS SDK, focusing on logging functionality. A new section titled "Custom Logger (Optional)" has been added to explain how developers can implement custom logging by extending the LoggerProtocol. The documentation demonstrates creating a custom logger and shows a simplified method for configuring the Kinde SDK, removing the named parameter in the configuration method.

Changes

File Change Summary
src/content/docs/developer-tools/sdks/native/ios-sdk.mdx - Added "Custom Logger (Optional)" section
- Updated SDK configuration method syntax
- Included code example for custom logger implementation

Suggested labels

sdk

🐰 A Logging Bunny's Delight
Swift code hops with grace so light,
Custom loggers now take flight,
Configuration clean and bright,
Documentation shining tight!
🌟 Code rabbit's joyful insight 🐾


📜 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 3ecaa15 and ddc06ca.

📒 Files selected for processing (1)
  • src/content/docs/developer-tools/sdks/native/ios-sdk.mdx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/content/docs/developer-tools/sdks/native/ios-sdk.mdx

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the sdk label Dec 17, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
src/content/docs/developer-tools/sdks/native/ios-sdk.mdx (2)

109-112: Enhance the custom logger introduction

The section would benefit from:

  1. Explaining why someone might want to use custom logging
  2. Mentioning the default Logger class and its capabilities
  3. Adding a reference to any logging-related configuration options

128-130: Fix typo in error message

There's a typo in the error message prefix.

-      print("[ERORR]: \(error.localizedDescription)")
+      print("[ERROR]: \(error.localizedDescription)")
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 690bc58 and 52fb60a.

📒 Files selected for processing (1)
  • src/content/docs/developer-tools/sdks/native/ios-sdk.mdx (1 hunks)
🔇 Additional comments (1)
src/content/docs/developer-tools/sdks/native/ios-sdk.mdx (1)

102-102: Document the breaking change in SDK configuration

The removal of the named parameter logger: in KindeSDKAPI.configure() could break existing implementations. Consider adding:

  1. A migration note for existing users
  2. Version information where this change was introduced

@marcosmartini marcosmartini merged commit 6539958 into kinde-oss:main Dec 23, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants