docs: document highlights and bible reader, split agent guidance into… - #175
Open
bmanquen wants to merge 2 commits into
Conversation
bmanquen
force-pushed
the
bm/YPE-3913-kotlin-docs-update-readme-contributing-and-any-agents-files-that-need-updating
branch
from
July 30, 2026 22:12
075917f to
28db967
Compare
… AGENTS.md - Add Bible Reader and Highlights sections to the README, covering the verse action sheet color picker, dark-theme highlight dimming, the two permission grant routes, rememberDataExchange, and the YouVersionApi.highlights API - Document isSignInEnabled, and move the language/version filtering subsections under Bible Reader where the version picker lives - Move repository guidance to AGENTS.md with CLAUDE.md pointing at it, matching the Swift SDK layout - Correct the YouVersionApi member list and the module names in the agent and contributing docs
bmanquen
force-pushed
the
bm/YPE-3913-kotlin-docs-update-readme-contributing-and-any-agents-files-that-need-updating
branch
from
July 30, 2026 22:12
28db967 to
fabd21a
Compare
davidfedor
approved these changes
Jul 31, 2026
- Fix the version catalog snippet, which referenced platform-sdk-core/-ui/-reader; the published artifact ids are platform-core, platform-ui, and platform-reader - Bump the documented version from 1.0.1 to 1.8.0 - Correct the minimum Android version to 6.0 (API 23), matching minSdk - Note the Bible Reader and highlights in the sample app list - Have semantic-release rewrite and commit the README version so it stops drifting from the released version
bmanquen
force-pushed
the
bm/YPE-3913-kotlin-docs-update-readme-contributing-and-any-agents-files-that-need-updating
branch
from
July 31, 2026 15:34
8520948 to
cece0fc
Compare
Contributor
Code Coverage ReportOverall Coverage: 87.7% Generated from Kover XML report. |
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.
… AGENTS.md
Greptile Summary
Updates the SDK documentation and repository guidance.
falseand must be checked.AGENTS.mdand corrects module and dependency names.Confidence Score: 5/5
The PR appears safe to merge.
No blocking failure remains; the README now explicitly distinguishes the Boolean failure result of create, update, and delete operations from exception-based read failures.
Important Files Changed
Reviews (3): Last reviewed commit: "docs: correct README install coordinates..." | Re-trigger Greptile
Context used: