Skip to content

docs: Fix Android SDK README code samples and API names - #200

Open
promptless[bot] wants to merge 1 commit into
mainfrom
promptless/sdk-docs-review
Open

promptless[bot] wants to merge 1 commit into
mainfrom
promptless/sdk-docs-review

Conversation

@promptless

@promptless promptless Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Open in Promptless

Why

Several code samples and API descriptions in the Android SDK READMEs don't match the SDK source. A developer who copies them gets compile errors or implements the wrong interface.

Goal

  • skyvault/README.md: replace six calls to the nonexistent Skyflow.initialize(config) with Skyflow.init(config). Fix the TokenProvider method name (getBearerToken, not getAccessToken) and the element-type count (8, not 5).
  • skyvault/README.md: change CollectOptions(tokens = …) to the real parameter token in 13 places and fix the additonalFields typo. Both module READMEs: correct CARD_HOLDER_NAME to CARDHOLDER_NAME.
  • Remove two notes that point readers to invokeConnection(), which is deprecated and internal, so apps can't call it.
  • samples/README.md: say that only the flowvault sample falls back to placeholder values when local.properties keys are unset.
  • Not in this PR: the Android Gradle Plugin 8.6.0+ requirement differs from the AGP 9.2.0 used to build the repo. Engineering should confirm which minimum is correct.

Testing

  • Every corrected identifier, signature, default, version, and link target was checked against the SDK source, build files, and samples in this repository at the current main commit. Review comments on this PR link each correction to the source line that supports it.
  • No SDK code, samples, or build files changed. Builds, tests, and installers were not run.
  • Vale prose checks report no new findings in the changed passages.

Trigger Events

Comment thread skyvault/README.md Resolved
Comment thread skyvault/README.md Resolved
@github-actions

Copy link
Copy Markdown

✅ Gitleaks Findings: No secrets detected. Safe to proceed!

Comment thread skyvault/README.md Resolved
@github-actions

Copy link
Copy Markdown

Semgrep Findings: Issues with Error level severity are found (Error is Highest severity in Semgrep), Please resolve the issues before merging.

Comment thread skyvault/README.md Resolved
Comment thread skyvault/README.md Resolved
Comment thread flowvault/README.md Resolved
Comment thread skyvault/README.md Resolved
Comment thread skyvault/README.md Resolved
Comment thread skyvault/README.md Resolved
Comment thread samples/README.md Resolved
Comment thread samples/README.md Resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants