Skip to content

docs: correct the stale claims in README and AGENTS - #8

Merged
Siddhesh2377 merged 1 commit into
mainfrom
docs/correct-stale-claims
Aug 16, 2026
Merged

docs: correct the stale claims in README and AGENTS#8
Siddhesh2377 merged 1 commit into
mainfrom
docs/correct-stale-claims

Conversation

@Siddhesh2377

Copy link
Copy Markdown
Collaborator

The docs had drifted from the app. Every claim below was checked against the code before changing it.

What was wrong

  • SDK version said 0.20.18 in three places. libs.versions.toml, app/gradle.lockfile and verification-metadata.xml all say 0.20.19.
  • The Kotlin SDK link pointed at tree/main/sdk/runanywhere-kotlin, a path that stopped existing at the 0.20.17 restructure. It is bindings/kotlin now.
  • runanywhere-onnx was described as registering Sherpa only. It registers ONNX Runtime for embeddings and Sherpa for STT/TTS/VAD, per the isSherpaRegistered path in ONNX.kt.
  • The features table listed 10 entries, missed 8 real screens, and named two that do not exist. Model management is ModelSelectionSheet; storage is a Settings section.
  • The QHexRT setup step sent readers to Settings then Downloads. The HF token field is under Private Downloads. Both sections exist, which made the old instruction actively misleading.
  • Requirements named Android Studio Ladybug, which is 2024.2 and cannot build AGP 9.2.1, and omitted the JDK 21 daemon toolchain that gradle-daemon-jvm.properties pins.
  • The project tree used the wrong root name and omitted tools/, download/, MainActivity.kt, both lockfiles and ci.yml.
  • LICENSE linked to the monorepo. This repo has its own, and it is the RunAnywhere License v1.0, not plain Apache 2.0.

What was added

The RUNANYWHERE_BASE_URL / RUNANYWHERE_API_KEY both-or-neither rule, which fails the configuration phase and was documented nowhere. In AGENTS.md: the per-variant ABI filters, the backend registration ordering constraint (CPU backends before initialize() or you get -422, QHexRT after), and a note that smoke.sh is a grep over source text and proves nothing about compilation.

Not changed

Three stale references live in source files, not docs, so this PR leaves them:

  • .github/workflows/ci.yml header comment says 0.20.18.
  • SolutionsYaml.kt points at two pre-0.20.17 monorepo paths and a script absent from this repo, so its "regenerate via" instruction fails if followed.
  • ui/theme/Color.kt and res/values/colors.xml reference examples/DESIGN_GUIDELINE.md, now docs/DESIGN_GUIDELINE.md.

Worth a separate look

This app declares runanywhere-qhexrt-android as a plain implementation dependency and records its checksums for 0.20.17 through 0.20.19 in verification-metadata.xml, which Gradle only writes for artifacts it actually downloaded. The monorepo's package-sdk.sh hard-fails on any *qhexrt* input and release.yml errors with "Private QHexRT artifacts must not be present in the public release". So either the guard misses the publishing path, or a private artifact is publicly resolvable. The docs here describe the observed behavior. Someone should confirm which it is.

Documentation only. No source changes.

@coderabbitai

coderabbitai Bot commented Aug 16, 2026

Copy link
Copy Markdown

Important

Review available on request

  • 🔍 Trigger review

Reviews should be triggered manually for repositories with fewer than 10 stars. Select Trigger review above or comment @coderabbitai review to review the latest changes. For a full review, comment @coderabbitai full review.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 2b0da782-3c67-4da1-b7ee-872620f06f43


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.

@Siddhesh2377
Siddhesh2377 merged commit 175d044 into main Aug 16, 2026
4 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.

1 participant