docs: correct the stale claims in README and AGENTS - #8
Merged
Conversation
|
Important Review available on request
Reviews should be triggered manually for repositories with fewer than 10 stars. Select Trigger review above or comment ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 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. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs had drifted from the app. Every claim below was checked against the code before changing it.
What was wrong
libs.versions.toml,app/gradle.lockfileandverification-metadata.xmlall say 0.20.19.tree/main/sdk/runanywhere-kotlin, a path that stopped existing at the 0.20.17 restructure. It isbindings/kotlinnow.runanywhere-onnxwas described as registering Sherpa only. It registers ONNX Runtime for embeddings and Sherpa for STT/TTS/VAD, per theisSherpaRegisteredpath inONNX.kt.ModelSelectionSheet; storage is a Settings section.gradle-daemon-jvm.propertiespins.tools/,download/,MainActivity.kt, both lockfiles andci.yml.What was added
The
RUNANYWHERE_BASE_URL/RUNANYWHERE_API_KEYboth-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 beforeinitialize()or you get -422, QHexRT after), and a note thatsmoke.shis 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.ymlheader comment says 0.20.18.SolutionsYaml.ktpoints 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.ktandres/values/colors.xmlreferenceexamples/DESIGN_GUIDELINE.md, nowdocs/DESIGN_GUIDELINE.md.Worth a separate look
This app declares
runanywhere-qhexrt-androidas a plainimplementationdependency and records its checksums for 0.20.17 through 0.20.19 inverification-metadata.xml, which Gradle only writes for artifacts it actually downloaded. The monorepo'spackage-sdk.shhard-fails on any*qhexrt*input andrelease.ymlerrors 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.