[promptless]

Open in Promptless

SK-3225: Correct the FlowVault Node SDK README and samples after #348 merged, and point readers of the root README to skyflow-flowvault-node.

Why

• The FlowVault README and the timeout-and-retry-config-example.ts sample say maxRetries defaults to off and that timeout covers the whole call, including retries. The source does something different. When maxRetries is unset, the generated client's requestWithRetries falls back to DEFAULT_MAX_RETRIES = 2. The timeout is passed to each makeRequest attempt, not to the retry loop.
• The Quickstart and insert-records.ts say the cluster ID comes from https://{clusterId}.vault.skyflowapis.com. Commit 5051ea7 moved FlowVault to the skyvault.* host (getFlowVaultURL), and the README's own vaultUrl example already uses it.
• The root README covers only skyflow-node. It doesn't tell anyone landing on the repo that a separate FlowVault package exists.

Goal

• flowvault/README.md: corrects the cluster URL comment, documents the real timeout and maxRetries behavior (60 s per attempt; 2 retries by default, 0 turns them off), and adds "Timeouts and retries" to the table of contents.
• flowvault/samples/vault-api/insert-records.ts and timeout-and-retry-config-example.ts: the same corrections in the sample comments.
• README.md: a short callout that sends FlowVault readers to flowvault/README.md and says to install only one package.
• Non-goal: skyvault/README.md (the npm README for skyflow-node) stays as it is. A relative link to flowvault/ would break there.

Testing

• Checked the claims against the merged source at 403c6f9: flowvault/src/skyflow/index.ts (getFlowVaultURL), flowvault/src/controller/vault/index.ts (requestOptions), and flowvault/_generated_/rest/src/core/fetcher/{Fetcher,requestWithRetries}.ts.
• Only comments and Markdown changed. No code was run.

Tech debt

• The timeout JSDoc in common/src/config/vault/index.ts ("Overall per-call timeout in seconds (includes retries)") has the same inaccuracy and ships in the published .d.ts. This PR doesn't fix it because it's a source change.

Trigger Events

• skyflowapi/skyflow-node PR #348: SK-3225: Split SDK into common / skyvault / flowvault; add FlowVault Node SDK