docs: rewrite the README as a consumer page - #14
Closed
Siddhesh2377 wants to merge 1 commit into
Closed
Conversation
…docs/DEVELOPMENT.md
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ 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 |
Collaborator
Author
|
Superseded by #15, which now carries the README alongside the app changes it describes. Keeping one PR per repo. |
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
1 participant
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.
Same rewrite the other three app repos are getting on their open README PRs, applied here. The Android screenshots PR already merged, so this one is standalone.
San asked for these to read as consumer apps rather than SDK reference material, and for the description to be cut by half. The README went from 297 lines to 136.
What changed
It opens with what a person can do with the app instead of how the SDK is wired in. Same skeleton the other three now use: download row, capability table, a slot where the GIF will go, build steps, one architecture diagram, links. The nine existing screenshots stay, moved under a "What it looks like" heading.
Everything cut is preserved, not deleted. Gradle pinning, dependency verification, testing an unreleased SDK build, CI, and troubleshooting all moved to
docs/DEVELOPMENT.md.One correction
The SDK section predated the QHexRT version split. It described a single
runanywhereversion covering all four artifacts, quoting0.20.19. That has not been true since the bump:gradle/libs.versions.tomlnow carriesrunanywhere = "0.20.24"alongsiderunanywhereQhexrt = "0.20.19", because QHexRT was excluded from Maven Central publishing after0.20.19and cannot advance past it there.docs/DEVELOPMENT.mdsays so, and the architecture diagram shows both versions.I verified this against Maven Central rather than the toml alone.
runanywhere-sdk,-llamacpp, and-onnxall resolve at 0.20.24;runanywhere-qhexrt-androidstops at 0.20.19.The GIF
Not in this PR. San asked for one GIF per platform showing tool calling, voice, and vision. That capture pass comes after the current app bugs are fixed, so there is an HTML comment marking where it goes rather than a broken image link.