Skip to content

docs: Fix iOS SDK README requirements, property names, and compile errors - #338

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

The iOS SDK READMEs list the wrong minimum iOS version, use property names that don't exist, and include Swift samples that don't compile.

Goal

  • Skyflow/README.md: change the minimum iOS version to 13.0 to match the podspecs and Package.swift. Use the real property name requiredAstrisk (the source misspells it). Mark RevealElementInput.label as required. Add the env: .DEV security warning that the FlowVault README already has, because the risk comes from shared SkyflowCore code.
  • Both READMEs: fix compile errors in samples (a single-quoted string literal, the SKyflow module typo, UIColor.BLACK). Add the missing iconStyles parameter to seven signature blocks. Replace a Java-style ArrayList<String>(). Remove references to the removed invokeConnection() API.
  • Document the public getById() method. Correct the claim that GetSample demonstrates it. Fix a table/tableName mismatch in the FlowVault README.
  • Not in this PR: the four empty per-sample READMEs and the stale CHANGELOG.

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 Skyflow/README.md
Comment thread Skyflow/README.md
@github-actions

Copy link
Copy Markdown

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

Comment thread Skyflow/README.md
Comment thread Skyflow/README.md
Comment thread Skyflow/README.md
Comment thread Skyflow/README.md
Comment thread Skyflow/README.md
Comment thread Skyflow/README.md
Comment thread Skyflow/README.md
Comment thread Skyflow/README.md
Comment thread Skyflow/README.md
Comment thread Skyflow/README.md
Comment thread Skyflow/Samples/README.md
Comment thread SkyflowFlowVault/README.md
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