OTA docs

[SandraZiv]

Summary by CodeRabbit

• Documentation
  • Added guidance for configuring base resources and over-the-air (OTA) updates.
  • Clarified default behavior, strict OTA failures, disabled update checks, caching, and cache cleanup.
  • Documented pre-bundling requirements and its incompatibility with live OTA updates.
  • Explained separate resource paths, hosts, and cache locations for base and OTA resources.
  • Updated examples to use nested resource configuration objects and improved Kotlin syntax highlighting.

[coderabbitai]

Warning

Review limit reached

@SandraZiv, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 45 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 1bfb9eea-7dd5-4bbd-864a-abea99ccebf3

📥 Commits

Reviewing files that changed from the base of the PR and between 5955121 and d1e3050.

📒 Files selected for processing (1)

• Release notes.md

📝 Walkthrough

Walkthrough

The documentation adds nested resource configuration guidance, pre-bundling instructions, OTA update rules, cache behavior, and blocking cleanup method details. Release notes align OTA behavior with the updated configuration rules.

Changes

Resource management

Layer / File(s)	Summary
Base resource configuration README.md	Adds navigation and documents ResourcesConfig, nested settings, migration, and pre-bundling configuration.
OTA resource behavior README.md, Release notes.md	Documents conditional strict failures, OTA paths, hosts, cache directories, update disabling, pre-bundling restrictions, and Kotlin code-block annotations.
Cached resource cleanup README.md	Documents closeAndDeleteCachedAssets() and close(), including their threading requirement.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

• microblink/blinkid-android#380: Implements the nested resource and OTA configuration options described by this documentation.

Suggested reviewers: medvedecrobertmb, ovi-cristur

🚥 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 clearly identifies the pull request as documentation changes for OTA resource management.
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
• Commit unit tests in branch ota-readme-update

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 2

🤖 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 `@README.md`:
- Around line 202-215: Update the README pre-bundling BlinkIdSdkSettings example
to explicitly set otaResourcesConfig with checkForUpdates disabled alongside
ResourcesConfig(download = false), preventing live OTA checks and preserving the
intended no-network bundled-resource configuration.
- Line 257: Align the strict OTA failure wording across README.md at lines
257-257 and Release notes.md at lines 158-158. Inspect BlinkIdSdk.initializeSdk
to determine whether failures use a Result<*> return path or throw exceptions;
if it returns Result<*>, change the Release notes.md wording to state that
initialization fails, otherwise update README.md to describe the exception path.

🪄 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: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d74f49f6-c0c0-4c4e-a9ea-7d4c2e29cd00

📥 Commits

Reviewing files that changed from the base of the PR and between 423537c and 80c2318.

📒 Files selected for processing (2)

• README.md
• Release notes.md