Skip to content

docs: update installation and root level readme (#164)#165

Merged
swatigoel merged 1 commit into
inji:developfrom
tw-mosip:update-docs-dev-sync
Jul 9, 2026
Merged

docs: update installation and root level readme (#164)#165
swatigoel merged 1 commit into
inji:developfrom
tw-mosip:update-docs-dev-sync

Conversation

@KiruthikaJeyashankar

@KiruthikaJeyashankar KiruthikaJeyashankar commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Added an “Available Libraries” section to the main README with links to the Kotlin, JavaScript, and Swift library resources.
    • Updated Kotlin usage instructions to reflect the current published package names and version information for Android/AAR and JVM/JAR builds.

* docs: update pixelpass installation guide

Signed-off-by: KiruthikaJeyashankar <kiruthikavjshankar@gmail.com>

* docs: root readme udpate

Signed-off-by: KiruthikaJeyashankar <kiruthikavjshankar@gmail.com>

---------

Signed-off-by: KiruthikaJeyashankar <kiruthikavjshankar@gmail.com>
@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

This PR updates documentation only. README.md gains an "Available Libraries" section linking to Kotlin, JavaScript, and Swift libraries. kotlin/Readme.md is updated to describe two separate Maven artifacts (pixelpass-aar, pixelpass-jar) with a new version 1.0.0-alpha.1, replacing the previous single artifact instructions.

Changes

Documentation updates

Layer / File(s) Summary
Available Libraries section
README.md
Adds a new section listing available Kotlin, JavaScript, and Swift libraries with links.
Kotlin artifact usage docs
kotlin/Readme.md
Updates usage instructions to describe two separate artifacts (pixelpass-aar, pixelpass-jar) with updated Gradle/Maven snippets and version bump to 1.0.0-alpha.1.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Poem

Two readmes hopped into the light,
New artifacts, versions just right,
AAR and JAR, side by side,
Links to libraries, README's pride,
A rabbit thumps twice—docs done tight! 🐇📄

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the docs-focused changes to installation guidance and the root README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@kotlin/Readme.md`:
- Around line 12-53: The README install coordinates are using a newer release
version than the Kotlin publishing default, so the documented artifacts may not
resolve. Update the version reference in kotlin/Readme.md to match the version
emitted by the publishing flow, and verify it stays consistent with the default
in PixelPass/publish-artifact.gradle (or ensure that script always overrides it
during release). Keep the artifact names pixelpass-aar and pixelpass-jar
unchanged while aligning the shared version string.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1d9460c3-ce75-4726-a481-1000d46f71b5

📥 Commits

Reviewing files that changed from the base of the PR and between 36ab226 and eeb6bcb.

📒 Files selected for processing (2)
  • README.md
  • kotlin/Readme.md

Comment thread kotlin/Readme.md
@swatigoel
swatigoel merged commit d3a8e19 into inji:develop Jul 9, 2026
5 checks passed
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.

2 participants