Skip to content

docs: Fix React SDK README hook names, required props, and broken examples - #244

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 React SDK README has examples that reference undefined variables, use the wrong hook name, or leave out a required prop. Several table-of-contents entries are missing or point at the wrong section.

Goal

  • README.md: change makeSkyflowStyles to useMakeSkyflowStyles, the name src/index.ts exports. Add the required container prop to the minimal FileRenderElement example. Fix undefined cardNameRef and callGet references and invalid optional-chaining syntax.
  • Fix the File Input table-of-contents anchor, add entries for Validations, Event Listener, and File Render, and remove duplicate ExpirationDateElement entries. Fix heading levels.
  • samples/SkyflowElements/README.md: fix a dangling reference and typos, and describe 10 samples that had no description.
  • Not in this PR: use3DS and useCollectListeners are exported but not documented.

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 README.md Resolved
@github-actions

Copy link
Copy Markdown

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

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

Copy link
Copy Markdown

Semgrep findings: No issues found, Good to merge.

Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread samples/SkyflowElements/README.md Resolved
Comment thread samples/SkyflowElements/README.md Resolved
Comment thread samples/SkyflowElements/README.md Resolved
Comment thread samples/SkyflowElements/README.md Resolved
Comment thread samples/SkyflowElements/README.md Resolved
Comment thread samples/SkyflowElements/README.md Resolved
Comment thread samples/SkyflowElements/README.md Resolved
Comment thread samples/SkyflowElements/README.md Resolved
Comment thread samples/SkyflowElements/README.md Resolved
Comment thread samples/SkyflowElements/README.md Resolved
Comment thread samples/SkyflowElements/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