Skip to content

docs: Fix skyflow-js and flowvault-js README code samples and sample run steps - #742

Open
promptless[bot] wants to merge 2 commits into
mainfrom
promptless/sdk-docs-review
Open

promptless[bot] wants to merge 2 commits into
mainfrom
promptless/sdk-docs-review

Conversation

@promptless

@promptless promptless Bot commented Oct 19, 2026

Copy link
Copy Markdown

Open in Promptless

Why

The JS SDK READMEs have samples that throw or are silently ignored, invalid JSON response examples, and Flow vault parameters marked optional even though validation requires them.

Goal

  • packages/skyflow-js/README.md: fix 16 instances of inputstyles to inputStyles, because the SDK silently ignores the lowercase key. Change skyflow.* to skyflowClient.* in 5 calls that reference an undefined variable. Fix two broken code blocks and the delete() example and response. Correct the setError() signature. Add MULTI_FILE_INPUT to the element types.
  • packages/skyflow-flowvault-js/README.md: mark tableName and column as required in the four create-element sections, because the shared core validation requires them.
  • packages/skyflow-js/samples/README.md: rewrite the broken "Using npm" run instructions from each sample's package.json.
  • Fix recurring typos in both READMEs.
  • Not in this PR: the undocumented 3DS helpers and the SDK versions pinned in the samples' package.json files.

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 packages/skyflow-js/README.md
@github-actions

Copy link
Copy Markdown

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

Comment thread packages/skyflow-js/README.md
Comment thread packages/skyflow-js/README.md
@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 packages/skyflow-js/README.md
Comment thread packages/skyflow-js/README.md
Comment thread packages/skyflow-flowvault-js/README.md
Comment thread packages/skyflow-js/README.md
Comment thread packages/skyflow-js/README.md
Comment thread packages/skyflow-js/samples/README.md
…eview

# Conflicts:
#	packages/skyflow-js/README.md
@github-actions

Copy link
Copy Markdown

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

@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.

@promptless

promptless Bot commented Oct 21, 2026

Copy link
Copy Markdown
Author

I noticed that some CI checks failed for this PR. I'm investigating whether the failures are caused by this suggestion. If they're unrelated or pre-existing, I'll leave this suggestion unchanged and create a separate suggestion if a standalone docs fix is needed.

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