Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Readme ui api updates #439

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.

Sign up for GitHub

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

Jump to bottom
Merged
swolfand merged 1 commit into from
Jan 5, 2026
Merged

Readme ui api updates #439

swolfand merged 1 commit into from
Jan 5, 2026

Conversation

@swolfand
Copy link
Collaborator

@swolfand swolfand commented Jan 5, 2026 •
edited by coderabbitai bot
Loading

Summary of changes

This PR updates the README.md to reflect the new modular structure of the Clerk Android SDK.

Key changes include:

  • Installation: Updated instructions to differentiate between the clerk-android-api (core API) and clerk-android-ui (prebuilt UI components) artifacts.
  • Import Paths: Corrected all code examples to use the new com.clerk.api package for core Clerk classes.
  • New UI Components Section: Added documentation for the AuthView and UserButton prebuilt Jetpack Compose UI components.
  • Maven Central Links: Updated links to point to the separate clerk-android-api and clerk-android-ui artifacts.

Open in Cursor Open in Web

Summary by CodeRabbit

  • Documentation
    • Updated Android SDK installation guide with clearer instructions for different usage scenarios (API-only or with prebuilt UI).
    • Added examples and guides for built-in UI components and customization options.
    • Expanded theming and integration documentation with practical code examples.

✏️ Tip: You can customize this high-level summary in your review settings.

@cursor
Copy link

cursor bot commented Jan 5, 2026

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
Learn more about Cursor Agents

@swolfand swolfand marked this pull request as ready for review January 5, 2026 19:31
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 5, 2026

📝 Walkthrough

Walkthrough

The README documentation has been restructured to reflect changes in the Clerk Android SDK installation and usage patterns. The installation process has been updated from a single-artifact approach to a dual-artifact model, introducing separate clerk-android-api and clerk-android-ui artifacts. Code examples and import paths throughout the documentation have been updated to reflect more granular namespacing (e.g., com.clerk.api.Clerk). New prebuilt UI components including AuthView and UserButton have been documented, along with expanded theming and typography customization sections featuring ClerkTheme, ClerkTypography, and related configuration classes.

Pre-merge checks

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Readme ui api updates' is vague and generic, using non-descriptive terms that don't clearly convey the main purpose of the documentation changes. Improve the title to be more specific and descriptive, such as 'Update README to document modular SDK structure with separate API and UI artifacts'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description check ✅ Passed The PR description comprehensively covers all key changes, including installation updates, import path corrections, new UI components, and Maven Central links, matching the required template structure.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between fad3837 and db6d71f.

📒 Files selected for processing (1)
  • README.md
🧰 Additional context used
📓 Path-based instructions (1)
**/*

⚙️ CodeRabbit configuration file

If there are no tests added or modified as part of the PR, please suggest that tests be added to cover the changes.

**/*: Only comment on issues that would block merging, ignore minor or stylistic concerns.
Restrict feedback to errors, security risks, or functionality-breaking problems.
Do not post comments on code style, formatting, or non-critical improvements.
Keep reviews short: flag only issues that make the PR unsafe to merge.
Group similar issues into a single comment instead of posting multiple notes.
Skip repetition: if a pattern repeats, mention it once at a summary level only.
Do not add general suggestions, focus strictly on merge-blocking concerns.
If there are no critical problems, respond with minimal approval (e.g., 'Looks good'). Do not add additional review.
Avoid line-by-line commentary unless it highlights a critical bug or security hole.
Highlight only issues that could cause runtime errors, data loss, or severe maintainability issues.
Ignore minor optimization opportunities, focus solely on correctness and safety.
Provide a top-level summary of critical blockers rather than detailed per-line notes.
Comment only when the issue must be resolved before merge, otherwise remain silent.
When in doubt, err on the side of fewer comments, brevity and blocking issues only.
Avoid posting any refactoring issues.

Files:

  • README.md
🪛 LanguageTool
README.md

[style] ~54-~54: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...Prebuilt UI Components Use this if you want to use the prebuilt Jetpack Compose UI com...

(REP_WANT_TO_VB)

🔇 Additional comments (2)
README.md (2)

35-65: Clarify dependency requirement for prebuilt UI components.

The "With Prebuilt UI Components" section (lines 52–60) should explicitly state whether the clerk-android-ui artifact alone is sufficient (i.e., it includes clerk-android-api as a transitive dependency), or if both artifacts must be added together. Currently, line 38 says UI "includes API," but the installation instructions don't clarify what users should actually add to build.gradle(.kts) when using prebuilt UI. This ambiguity could cause users to either miss the API dependency or add unnecessary duplicates.

Additionally, verify that the version numbers shown (API at 0.1.28 vs. UI at 0.1.3) are intentional, and clarify which API version is bundled with the UI artifact if they differ.

123-126: Verify UI component import package paths.

The documentation shows inconsistent package naming:

  • Core theming classes use com.clerk.api.ui.* (lines 124–126: ClerkTheme, ClerkTypography, ClerkTypographyDefaults)
  • UI components use com.clerk.ui.* (lines 152, 165: AuthView, UserButton)

Confirm these package paths match the actual clerk-android-ui artifact. If incorrect, users copying these examples will encounter compile-time import failures.

Also applies to: 152-152, 165-165

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@swolfand swolfand merged commit f89ef75 into main Jan 5, 2026
10 checks passed
@swolfand swolfand deleted the cursor/readme-ui-api-updates-c65d branch January 5, 2026 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@swolfand @cursoragent