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

Move iOS and Android SDK to development phase #181

Merged
merged 1 commit into from
Dec 26, 2024
Merged

Conversation

hackerwins
Copy link
Member

@hackerwins hackerwins commented Dec 26, 2024

What this PR does / why we need it?

Move iOS and Android SDK to development phase

Any background context you want to provide?

What are the relevant tickets?

Fixes #

Checklist

  • Added relevant tests or not required
  • Didn't break anything

Summary by CodeRabbit

  • New Features

    • Conditional rendering of iOS and Android SDK documentation links in the mobile dropdown, now only visible in development mode.
    • Added informational note about forthcoming iOS and Android SDKs in the getting started documentation.
  • Documentation

    • Introduced phase: development metadata in various SDK-related documents to categorize their current status.

Copy link

coderabbitai bot commented Dec 26, 2024

Walkthrough

The pull request introduces development-specific modifications across multiple files. The changes primarily focus on conditionally rendering iOS and Android SDK documentation links in the mobile dropdown menu and adding a phase: development metadata field to various documentation files. These updates aim to provide clearer guidance about the current status of SDK documentation while ensuring development-specific content is appropriately managed.

Changes

File Change Summary
components/Layout/MobileGnbDropdown.tsx Conditionally render iOS and Android SDK links only in development mode
docs/android-sdk.mdx, docs/ios-sdk.mdx, docs/getting-started/with-android-sdk.mdx, docs/getting-started/with-ios-sdk.mdx Added phase: development metadata
docs/getting-started.mdx Added informational line about forthcoming iOS and Android SDKs

Poem

🐰 A Rabbit's SDK Whisper 🔧

In dev mode, links softly peek,
Metadata tags begin to speak,
SDKs brewing, not quite done,
A glimpse of coding just begun!
Hop along the development trail 🚀


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.

Copy link

@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: 0

🧹 Nitpick comments (1)
components/Layout/MobileGnbDropdown.tsx (1)

90-113: Consider using a configuration flag or separate environment value for SDK development links.

Currently the code checks process.env.NODE_ENV === 'development' to conditionally render the iOS/Android SDK sections. While this works correctly for a straightforward dev vs. production setup, you may want to consider using a more granular environment variable (e.g. process.env.NEXT_PUBLIC_SHOW_MOBILE_SDK) for better control across multiple environments (e.g. staging). This approach can keep dev/production checks focused on build processes and preserve feature toggles for controlling feature availability.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 776f514 and 0016bb6.

📒 Files selected for processing (6)
  • components/Layout/MobileGnbDropdown.tsx (1 hunks)
  • docs/android-sdk.mdx (1 hunks)
  • docs/getting-started.mdx (1 hunks)
  • docs/getting-started/with-android-sdk.mdx (1 hunks)
  • docs/getting-started/with-ios-sdk.mdx (1 hunks)
  • docs/ios-sdk.mdx (1 hunks)
✅ Files skipped from review due to trivial changes (5)
  • docs/getting-started.mdx
  • docs/ios-sdk.mdx
  • docs/android-sdk.mdx
  • docs/getting-started/with-android-sdk.mdx
  • docs/getting-started/with-ios-sdk.mdx

@hackerwins hackerwins merged commit 078c18d into main Dec 26, 2024
2 checks passed
@hackerwins hackerwins deleted the hide-mobile-sdks branch December 26, 2024 01:44
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