Skip to content

docs: document highlights and bible reader, split agent guidance into… - #175

Open
bmanquen wants to merge 2 commits into
feat/add-highlightsfrom
bm/YPE-3913-kotlin-docs-update-readme-contributing-and-any-agents-files-that-need-updating
Open

docs: document highlights and bible reader, split agent guidance into…#175
bmanquen wants to merge 2 commits into
feat/add-highlightsfrom
bm/YPE-3913-kotlin-docs-update-readme-contributing-and-any-agents-files-that-need-updating

Conversation

@bmanquen

@bmanquen bmanquen commented Jul 30, 2026

Copy link
Copy Markdown
Collaborator

… 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

Greptile Summary

Updates the SDK documentation and repository guidance.

  • Documents Bible Reader configuration, authentication, highlight permissions, and highlight APIs.
  • Clarifies that unauthenticated highlight mutations return false and must be checked.
  • Moves contributor guidance into AGENTS.md and corrects module and dependency names.
  • Keeps README dependency versions synchronized through semantic-release.

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

Filename Overview
README.md Adds Bible Reader and highlights documentation, including accurate mutation failure signaling that resolves the previous review finding.
.releaserc.json Extends release preparation and committed assets so README dependency examples track the released SDK version.
AGENTS.md Centralizes repository architecture, workflow, and coding guidance.
CLAUDE.md Replaces duplicated guidance with a pointer to AGENTS.md.
CONTRIBUTING.md Corrects module names and their dependency descriptions.

Reviews (3): Last reviewed commit: "docs: correct README install coordinates..." | Re-trigger Greptile

Context used:

@bmanquen
bmanquen requested a review from davidfedor July 30, 2026 21:29
Comment thread README.md Outdated
@bmanquen
bmanquen force-pushed the bm/YPE-3913-kotlin-docs-update-readme-contributing-and-any-agents-files-that-need-updating branch from 075917f to 28db967 Compare July 30, 2026 22:12
… 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
bmanquen force-pushed the bm/YPE-3913-kotlin-docs-update-readme-contributing-and-any-agents-files-that-need-updating branch from 28db967 to fabd21a Compare July 30, 2026 22:12
Comment thread README.md Outdated
Comment thread README.md Outdated
- 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
bmanquen force-pushed the bm/YPE-3913-kotlin-docs-update-readme-contributing-and-any-agents-files-that-need-updating branch from 8520948 to cece0fc Compare July 31, 2026 15:34
@github-actions

Copy link
Copy Markdown
Contributor

Code Coverage Report

Overall Coverage: 87.7%

Generated from Kover XML report.

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.

2 participants